Add breaking changes to GitHub release notes
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 9.8k
- Forks
- 808
- PR merge metrics
- No merged PRs in 30d
Description
The release notes on GitHub are currently empty. It would be beneficial if these contained the breaking changes for each major release. Currently these are only showing in the github repo.
This is about hooking into the release scripts and pushing the changes to the Github releases using the Github API. Start by investigating how the release script works by looking at the scripts in package.json and then how to extract the relevant parts from the changelog markdown file. The github API is quite easy to grok.
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 reading the release scripts listed in package.json and then inspect the changelog markdown to determine how breaking changes are identified. Review the GitHub API flow for publishing release notes. Done means each major GitHub release contains its relevant breaking changes rather than an empty release note.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, javascript
- Domain
- release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100