search

decentralized-identity / sidetree-reference-impl

Sidetree Reference Implementation
Apache License 2.0
5 stars 7 forks source link

Add autochange log generation and commit message linting #26

Open tplooker opened 4 years ago

tplooker commented 4 years ago

To aid in automatic changelog generation, enforcing commit messages of the following form by a combination of husky commitlint would allow a tool like conventional-changelog to automatically generate the changelog on releases of the reference implementation.

A sample of a project using this setup can be seen here

OR13 commented 4 years ago

we use this approach as well, I think this would be a major process and developer experience improvement.

@thehenrytsai @gjgd any comments on this approach?

gjgd commented 4 years ago

Yay for conventional commits, that'd be a great addition to this project! Just note that all developers must agree and follow the convention otherwise the generated changelog documentation will be garbage

https://www.conventionalcommits.org/en/v1.0.0/