Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the maintainers/editors for v1? #80

Open
earth2marsh opened this issue Oct 16, 2024 · 9 comments
Open

Update the maintainers/editors for v1? #80

earth2marsh opened this issue Oct 16, 2024 · 9 comments

Comments

@earth2marsh
Copy link
Member

The maintainers list lists an older TSC member list. It might be updated, removed, or pointed to the OpenAPI Specification's document (reduce future toil).

There is a separate editors list that might also deserve a review before v1 launch?

@ralfhandl ralfhandl added this to the Release 1.0 milestone Oct 17, 2024
@ralfhandl
Copy link
Contributor

@earth2marsh The EDITORS.md file is used by the respec script to populate the "Editors:" list in the HTML version of the spec.

Please comment here or open a PR if it needs to be changed.

@earth2marsh
Copy link
Member Author

I'm suddenly wobbly about what "editors" means!

Contributors suggests people who submit PRs that then get merged. It could also include people who join discussions/issues/Slack/Zoom discussions.

Maintainers maps onto the TSC in terms of people who review/approve merges for OAS. (CODEOWNERS also intersects a bit?)

So what then does Editors mean? It seems like it serves like it credits the people behind the document (not unlike RFC authors). Is that accurate? If so, what are the criteria for inclusion?

@ralfhandl
Copy link
Contributor

My take, aligned with my top ten Google results:

  • Contributors contribute content, they cannot publish it.
  • Editors publish content and try their best to assure its consistency and correctness. They may also be contributors.

Translated to our current setup:

  • Contributor is anyone who creates a PR that is merged.
  • Editors are maintainers that merge PRs.

For OAS this is reflected in the three different files CONTRIBUTORS.md, EDITORS.md, and MAINTAINERS.md, although the CONTRIBUTORS.md currently requires 25 merged PRs - we could (should?) relax that.

For Overlay the CONTRIBUTORS.md is missing, and the MAINTAINERS.md is outdated.

@handrews
Copy link
Member

@ralfhandl is the CONTRIBUTORS.md file actually used for anything or does it just sit there separate from the spec publishing process?

@dret
Copy link
Contributor

dret commented Oct 19, 2024

@ralfhandl, what do you expect me to do here?

@ralfhandl
Copy link
Contributor

what do you expect me to do here?

Nothing, wrong button 🙄

@ralfhandl
Copy link
Contributor

does it just sit there separate from the spec publishing process

Exactly 😎

@lornajane
Copy link
Contributor

I'd like to propose removing the contributors file. Pull requests are not the only valued activity on our projects, and it doesn't send the correct message IMO.

@handrews
Copy link
Member

@lornajane agreed, I've filed OAI/OpenAPI-Specification#4148 to track.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants