OAI / OAI/Overlay-Specification
Branching strategy in CONTRIBUTING.md is outdated (I think)
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 121
- Forks
- 38
- Avg merge
- 53m
- Merged PRs (30d)
- 6
Description
I am confused about our branching strategy in the Overlays repo.
I tried reading: https://github.com/OAI/Overlay-Specification/blob/main/CONTRIBUTING.md#branching-strategy
That says that work in progress versions go in versions/X.Y.Z-dev.md in main.
But Version 1.2 is in src/overlay.md in the 1.2-dev branch.
@baywet believes that the branching strategy being used for Version 1.2 is correct, and CONTRIBUTING.md is describing a old branching strategy that has not been updated.
If that's correct, we should update CONTRIBUTING.md to describe the current branching strategy.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the branching strategy described in CONTRIBUTING.md with the current Version 1.2 layout in src/overlay.md and the 1.2-dev branch. Confirm which workflow is current, then update the branching-strategy section so it matches that workflow and verify that the Version 1.2 example is accurately represented.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 70/100