Request: publish a CHANGELOG
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- rust
- Domain
- documentation
Research direction
Start by reviewing the repository history and the tagged releases covering the headers v0.3 to v0.4 upgrade. Add a CHANGELOG.md that records the relevant release changes so consumers can compare versions without relying on a git diff, then verify that the entries match the release history.
Written by the indexing model from the issue text.
Description
I'm one of the maintainers for the Volta project, and got a Dependabot upgrade PR to bump from headers v0.3 to v0.4. I came here to find out what those changes were (which Dependabot will also do in an automated way as best it can if you have a CHANGELOG.md or release notes on GitHub’s tagged releases) and was sad to discover that there’s no way for me to see what changed other than doing an actual Git diff between the two!
It would be delightful and really helpful for consumers using this library directly if you added an actual CHANGELOG file for the crate! 🙏
- Dominant language
- Rust
- Stars
- 200
- Forks
- 107
- PR merge metrics
- No merged PRs in 30d
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.
More from hyperium/headers
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
Difficulty 3/5 1-2 days Newbie friendliness 78/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Link support Open
Difficulty 4/5 3-5 days Newbie friendliness 38/100
All issues in hyperium/headers
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
state:needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
zed-industries/zed#64680 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
RustPython/RustPython#8802 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
TheLarkInn/aipm#2390 ·