Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain our use of Conventional Commits in CONTRIBUTING.md #744

Closed
4 tasks done
Tracked by #99
resir014 opened this issue Aug 16, 2021 · 1 comment · Fixed by #750
Closed
4 tasks done
Tracked by #99

Explain our use of Conventional Commits in CONTRIBUTING.md #744

resir014 opened this issue Aug 16, 2021 · 1 comment · Fixed by #750
Assignees
Labels
documentation Improvements or additions to documentation dx Developer Experience

Comments

@resir014
Copy link
Member

resir014 commented Aug 16, 2021

Description

This repository uses the Conventional Changelog specification for our commit messages + Pull Request titles. Explain in the CONTRIBUTING.md file about how we use these commit messages.

Implementation model

The Conventional Changelog specification can be read here: https://www.conventionalcommits.org/en/v1.0.0/ - as a refresher:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

The commit types that we use are: feat, fix, refactor, docs, build, chore, perf, style, test. This follows the Angular commit message guidelines.

If possible, we should also define the scopes that this project uses.

Tasks

  • Explain our use of Conventional Changelog specification
  • Explain the commit types that we use
  • Explain the use of commitlint to lint commit messages
  • (Optional) Switch default merge type for PRs to squash merge-only, to ensure all commit messages match standards
@resir014 resir014 added documentation Improvements or additions to documentation dx Developer Experience labels Aug 16, 2021
@resir014 resir014 changed the title Explain our use of Conventional Commits Explain our use of Conventional Commits in CONTRIBUTING.md Aug 16, 2021
@resir014
Copy link
Member Author

Final task has already done through the GitHub repo settings.

image

We can update each PR's title with the appropriate conventional commit standards before triggering automerge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation dx Developer Experience
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants