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

Governance: Document development/enhancement process for Arazzo #227

Open
frankkilcommins opened this issue Jul 31, 2024 · 5 comments
Open
Assignees
Labels
house-keeping House keeping items process

Comments

@frankkilcommins
Copy link
Collaborator

Create a DEVELOPMENT.md to describe the appropriate process for making patch, minor, major changes to the Arazzo Specification.

Review/consult with @oai/tsc

@frankkilcommins frankkilcommins self-assigned this Jul 31, 2024
@frankkilcommins frankkilcommins added the house-keeping House keeping items label Jul 31, 2024
@handrews
Copy link
Member

@frankkilcommins because

  1. Most github repos now use CONTRIBUTING.md instead of DEVELOPMENT.md
  2. The OAI/OpenAPI-Specification DEVELOPMENT.md is so out-of-date that no one even knows where to start to fix it

on a recent TDC call we decided to start a CONTRIBUTING.md (which I should do right now actually) and begin filling it out with up-to-date guidance and deleting things from DEVELOPMENT.md

So I would recommend a CONTRIBUTING.md here instead.

@frankkilcommins
Copy link
Collaborator Author

@handrews completely agree. If we're updating the process to move towards a CONTRIBUTING.md then even better. We'll follow suit here.

My main aim is to quickly define the rules needed to ensure that we can move forward safely now that we've published 1.0.0. I've created https://github.com/OAI/Arazzo-Specification/tree/v1.0.0-dev for working on patches/typos (of which some have been spotted, so want to get them fixed asap).

@handrews
Copy link
Member

handrews commented Aug 1, 2024

@frankkilcommins here's the PR for starting up CONTRIBUTING in the OAS repo:

@handrews
Copy link
Member

handrews commented Aug 1, 2024

@frankkilcommins That PR I linked above include issue links to various topics under discussion, including the plan to move away from having both a separate branch and a separate file for each version. Because doing that makes it incredibly difficult to use git to manage multiple release lines. idk if you want to try to start that process here, but it's worth cosidering. Especially if you want to start on 1.1.0 while also doing a 1.0.1:

@frankkilcommins
Copy link
Collaborator Author

Small update here. @handrews is making great progress on OAI/OpenAPI-Specification#3677 and detailing out the future process for OAS.

I'll work with Henry to see if we can align a similar process for Arazzo from this point on and in advance of merging v1.0.0-dev changes into main and creating a patch release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
house-keeping House keeping items process
Projects
None yet
Development

No branches or pull requests

2 participants