-
Notifications
You must be signed in to change notification settings - Fork 33
[Tooling] CHANGELOG and Version Bump PreCommit Hook #93
Copy link
Copy link
Closed
Labels
communityOpen to or owned by a non-core team memberOpen to or owned by a non-core team memberinfraCore infrastructure - not protocol relatedCore infrastructure - not protocol related
Milestone
Description
Description
The v1 codebase is required to document all important changes in a CHANGELOG.md at the root of the repository and module specific CHANGELOG.md if the changes impacted the module in-question. In addition to that, the version should be bumped accordingly.
This issue is a perfect starter task for community contributions.
Origin Document
This issue was created as a starter task for community contribution, as suggested per in the following conversation
Goals
- Add pre-commit logic to validate if CHANGELOGs and the version were updated accordingly before commit
- Allow this to be disable locally
- Configure CI to always run this validation before merge of PRs
Non-Goals
- Adding CI/CD to the V1 Codebase
- Automating the population of the CHANGELOG based on git-diff results
Maintainers
Creator: @derrandz
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
communityOpen to or owned by a non-core team memberOpen to or owned by a non-core team memberinfraCore infrastructure - not protocol relatedCore infrastructure - not protocol related
Type
Projects
Status
Done