OpenZeppelin / OpenZeppelin/compact-contracts
Add Automatic Changelog Tooling, Consider Implementing Machine Readable Commit Convention
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 55
- Forks
- 29
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 25
Description
At the moment we don't have a releasing process so it doesn't make sense to spend a lot of time setting up this tooling. Especially, when we have no established user base. However, at some point when we find ourselves sinking a ton of time into creating a CHANGELOG for each release we should consider implementing the above.
The GUIDELINES.md file should be updated with:
All changes to the core codebase (excluding tests, auxiliary scripts, etc.) must be documented in a changelog, except for purely cosmetic or documentation changes.
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
Open GUIDELINES.md and review its existing contribution and change-record guidance. Add the stated changelog convention for core code changes, preserving the listed exceptions; the work is done when the guideline is present and no automatic tooling is introduced prematurely.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100