[Workflow] changing CHANGELOG during development
Open
Nobody has claimed this yet.
documentation
pyfar-workflow
- Dominant language
- Python
- Stars
- 3
- Forks
- 2
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 3
Description
I would suggest to start updating the CHANGELOG during development. So for each PR the Changelog should be updated in the [Unreleased] section.
this enhances the quality of the changelog, since we write it and review it.
and it makes release easier.
this worklfow is also suggested by https://keepachangelog.com/en/1.0.0/
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
Read the repository's CHANGELOG and its [Unreleased] section first, then compare the proposed workflow with Keep a Changelog 1.0. Done means the contribution workflow is documented and the [Unreleased] section is updated for each PR, with agreement on how entries are reviewed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100