Process for unintentional breaking changes
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 4.4k
- Forks
- 675
- Avg merge
- 22h 29m
- Merged PRs (30d)
- 1
Description
As mentioned in a TSC meeting a couple weeks ago, should we have documented processes for breaking changes?
- what do collaborators do?
- what is the responsibility of releasers?
- etc.
It would be nice to document what defines "breaking" and how to triage.
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
Start by reviewing the TSC meeting context and the questions about collaborators, releasers, breaking changes, and triage. Done means documenting what qualifies as a breaking change and defining the responsibilities and process for handling one.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, nodejs
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100