Add CHANGELOG
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 239
- Forks
- 36
- Avg merge
- 28m
- Merged PRs (30d)
- 3
Description
When Dependabot raises new PR's for ci-queue updates there is no information contained in the PR about what changed which forces a developer to dive into this project to understand what has happened.
Once inside this project, there is no CHANGELOG or Github releases which forces developers to manually inspect PR's or commits to understand what has happened.
This is a poor use of developer's time.
Adding a CHANGELOG or adding information to Github releases can streamline this process and give more confidence to consumers when updates occur.
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's commit history and prior Dependabot PRs to identify the changes consumers need summarized. Check the existing GitHub release history, then document the relevant changes in a CHANGELOG or release notes so future updates can be understood without inspecting individual commits.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100