deepspeedai / deepspeedai/DeepSpeed
Consider adding a changelog to track version history
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 43.1k
- Forks
- 5k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 112
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 with the Keep a Changelog convention linked in the issue and review the repository's existing version history before editing. Create CHANGELOG.md with an Unreleased section and categorized entries for relevant changes; done means the file documents version history clearly and follows the requested format.
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