Add Conventional Commit tooling

[jedeen]

Context

Currently, we have guidelines for how to format commit message in general, but do not have enforced standards for how to add commit metadata (is this a breaking change, is this a bugfix, other changes adjacent to semantic versioning concerns, etc.) We stopgap some of that with Github labels, but those do not exist in the Git commit history.

Proposal

• enforce the Conventional Commit format for all commits that are merged to the main branch
  • this will allow us to automatically determine the appropriate semantic version for post-1.0 releases of Excalibur
• add optional linting command for developers to use locally
  • this prevents having to require that community contributors follow the strict commit message format, since we squash and rebase all pull requests when merging
• automate changelog updates on pull request merge
  • if commit messages are required to be well-formatted and provide proper context, then the vast majority of the changelog can be automated
• maintain the majority of our git commit message format conventions, as described in our Contributing document
• update the Contributing document to include the new Conventional Commits formatting guidelines

Commit Format Examples

General template:

<type>[optional scope]: <Description>

[optional body]

closes #issue_number

Specific example:

fix: Prevent sounds from playing when the game is stopped

Ensure all sounds stop when the game is stopped, and Sound.play() does not play sounds when the game is stopped

closes #1476 

additional info: https://www.conventionalcommits.org

See also #777

[kamranayub]

We use a GitHub app called Semantic Merge I think that ensures PR titles are consistent with CC and then can auto merge them. This would be great!

…

On Fri, Apr 24, 2020, 4:31 PM jedeen ***@***.***> wrote: Context Currently, we have guidelines for how to format commit message in general, but do not have enforced standards for how to add commit metadata (is this a breaking change, is this a bugfix, other changes adjacent to semantic versioning concerns, etc.) We stopgap some of that with Github labels, but those do not exist in the Git commit history. Proposal - enforce the Conventional Commit format for all commits that are merged to the main branch - this will allow us to automatically determine the appropriate semantic version for post-1.0 releases of Excalibur - add linting command for developers to use locally (if they wish) - this prevents having to require that community contributors follow the strict commit message format, since we squash and rebase all pull requests - automate changelog updates on pull request merge - if commit messages are required to be well-formatted and provide proper context, then the vast majority of the changelog can be automated - maintain the majority of our git commit message format conventions, as described in our Contributing document Commit Format Examples General template: <type>[optional scope]: <Description> [optional body] closes #issue_number Specific example: fix: Prevent sounds from playing when the game is stopped Ensure all sounds stop when the game is stopped, and Sound.play() does not play sounds when the game is stopped closes #1476 additional info: https://www.conventionalcommits.org — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#1503>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAEJU22QH6SOMR2QX4UVL7TROIAJ5ANCNFSM4MQNUB2Q> .

[kamranayub]

Here it is: https://github.com/zeke/semantic-pull-requests

…

On Fri, Apr 24, 2020, 7:31 PM Kamran Ayub ***@***.***> wrote: We use a GitHub app called Semantic Merge I think that ensures PR titles are consistent with CC and then can auto merge them. This would be great! On Fri, Apr 24, 2020, 4:31 PM jedeen ***@***.***> wrote: > Context > > Currently, we have guidelines for how to format commit message in > general, but do not have enforced standards for how to add commit metadata > (is this a breaking change, is this a bugfix, other changes adjacent to > semantic versioning concerns, etc.) We stopgap some of that with Github > labels, but those do not exist in the Git commit history. > Proposal > > - enforce the Conventional Commit format for all commits that are > merged to the main branch > - this will allow us to automatically determine the appropriate > semantic version for post-1.0 releases of Excalibur > - add linting command for developers to use locally (if they wish) > - this prevents having to require that community contributors > follow the strict commit message format, since we squash and rebase all > pull requests > - automate changelog updates on pull request merge > - if commit messages are required to be well-formatted and provide > proper context, then the vast majority of the changelog can be automated > - maintain the majority of our git commit message format conventions, > as described in our Contributing document > > Commit Format Examples > > General template: > > <type>[optional scope]: <Description> > > [optional body] > > closes #issue_number > > Specific example: > > fix: Prevent sounds from playing when the game is stopped > > Ensure all sounds stop when the game is stopped, and Sound.play() does not play sounds when the game is stopped > > closes #1476 > > additional info: https://www.conventionalcommits.org > > — > You are receiving this because you are subscribed to this thread. > Reply to this email directly, view it on GitHub > <#1503>, or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AAEJU22QH6SOMR2QX4UVL7TROIAJ5ANCNFSM4MQNUB2Q> > . >

[jedeen]

Other options to consider/combine:

• https://github.com/conventional-changelog/commitlint
• https://github.com/conventional-changelog/conventional-changelog
• https://www.npmjs.com/package/semantic-release
• https://www.npmjs.com/package/standard-version