Skip to content

Improve commit messages #391

Description

@ErikBjare

Since we've started auto-generating changelogs I started looking into how other projects do it and many do so by enforcing a standard format for commit messages.

One prominent standard is Conventional Commits. A few examples:

fix: fixed bug #X
docs: updated README
ci: added platform to CI

Types I propose we use are: fix, feat, build, chore, ci, docs, style, refactor, perf, test

It's important that we strike a good balance. We don't want to discourage new contributors by being nitpicky. Worst case we can always clean up the changelog manually, but having at least most commit follow the convention would make things easier.

  • Update CONTRIBUTING.md with guidelines

Related to #377

Thoughts @johan-bjareholt, @xylix?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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