Skip to content

Implement conventional commits for automatic versioning #327

@andrewb1269

Description

@andrewb1269

I propose we implement the use of conventional commits in this repository. This will not only improve commit messages with a standard prefix (feat, fix, chore, ci, docs, test, etc.) but it will also allow for automatic semantic versioning. We can then use semantic release to trigger new releases on every push to main automatically.

We need to set up a new workflow to check the title of a PR to ensure the title follows conventional commit standards.

Once the workflow is in place we should add it as a status check to all PRs that must pass before merging.

We should update the settings of the repo (Settings > General > scroll down to allowed types of merges > set to "Squash, PR Title Only") so the title of the commit matches the approved conventional commit structure.

@daveallie if you believe this functionality would be helpful please @ me and I'll be happy to implement it. I won't be able to update the status checks and merge strategy of the repo, though. Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions