Consider adding a changelog to track version history
Open
Beginner friendly
Nobody has claimed this yet.
Product Area: Other
Waiting for: Product Owner
- Dominant language
- Python
- Stars
- 44.8k
- Forks
- 4.9k
- Avg merge
- 21h 23m
- Merged PRs (30d)
- 607
Description
Feature Request
Summary
A CHANGELOG.md file would help users understand what changed between versions and make upgrade decisions easier.
Motivation
When upgrading dependencies, developers need to know:
- What bugs were fixed
- What new features were added
- Whether there are any breaking changes
Suggested Format
Follow the Keep a Changelog convention:
# Changelog
## [Unreleased]
## [1.2.0] - 2024-01-15
### Added
- New feature X
### Fixed
- Bug with Y under Z conditions
### Changed
- Behaviour of Z is now more consistent
Additional Context
This is purely a documentation change with no code impact.
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 repository's existing release and version history alongside the Keep a Changelog convention linked in the issue. Create CHANGELOG.md with an Unreleased section and relevant version sections covering additions, fixes, changes, and breaking changes; the documentation is done when users can compare releases and understand upgrade impact.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100