search

OAI / Arazzo-Specification

The Arazzo Specification - A Tapestry for Deterministic API Workflows
https://spec.openapis.org/arazzo/latest.html
Apache License 2.0
214 stars 42 forks source link

Governance: Document development/enhancement process for Arazzo #227

Open frankkilcommins opened 3 months ago

frankkilcommins commented 3 months ago

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

Review/consult with @oai/tsc

handrews commented 3 months ago

@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 commented 3 months ago

@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 commented 3 months ago

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

handrews commented 3 months ago

@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 commented 2 weeks ago

Small update here. @handrews is making great progress on https://github.com/OAI/OpenAPI-Specification/issues/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.