Maintain a changelog
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 44.7k
- Forks
- 3.6k
- Avg merge
- 21m
- Merged PRs (30d)
- 1
Description
Is your feature request related to a problem? Please describe.
Yes, I don't know what is contained in each release and therefore I do not know whether I should update or not.
Describe the solution you'd like
The introduction of a public changelog in the root of the repository, and the relevant sections of the changelog appended to releases as they are created to make it easy to see what has changed in that release.
Additional context
A tool like https://github.com/github-changelog-generator/github-changelog-generator would automate this.
Contributor guide
No contributing guide indexed for this repository
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 repository root and the process for creating releases. Evaluate whether github-changelog-generator can automate the changelog, then define how relevant sections are appended to each release. Done means a public root-level changelog exists and releases include their relevant changes.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100