Skip to content

Commit

Permalink
docs: add guidance on writing commit messages (#5071)
Browse files Browse the repository at this point in the history
  • Loading branch information
thisislawatts authored Mar 6, 2024
1 parent c0d9ddf commit 6cd177d
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,12 +219,6 @@ docs: update contributing guide
We often get questions on how to contribute to this repo. What versions to use, what the workflow is, and so on. This change updates our CONTRIBUTING guide to answer those types of questions.
```

### No breaking changes

Your changes must be backwards compatible and cannot break existing user pipelines.

Don't use `BREAKING CHANGE` or exclamation mark `!` from the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

### Commit types

The commit type is used to summarize intent and to automate various steps.
Expand All @@ -233,12 +227,24 @@ The commit type is used to summarize intent and to automate various steps.
| ---------- | ----------------------------------------------- |
| `feat` | A new user-facing feature. |
| `fix` | A bug fix for an existing feature. |
| `refactor` | Changes which do not affect existing features. |
| `chore` | Build, workflow and pipeline changes. |
| `test` | Changes to tests for existing features. |
| `refactor` | Changes which do not affect existing features. |
| `docs` | Changes to documentation for existing features. |
| `chore` | Build, workflow and pipeline changes. |
| `revert` | Reverting a previous commit. |

### Writing commit messages

When writing your commit message, keep in mind that it will be used to build our user-facing release notes. To ensure everyone benefits from your changes, please write messages that are clear and concise, even for those unfamiliar with the code itself.

Focus on the _what_ rather than the _how_. Instead of "Upgraded external-dependency" explain the impact this has on users: "Improved search accuracy to deliver more relevant results". This way, users can easily see the value of upgrading to the latest release.

### No breaking changes

Your changes must be backwards compatible and cannot break existing user pipelines.

Don't use `BREAKING CHANGE` or exclamation mark `!` from the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

## Pushing changes

Once you have committed your changes, review them locally, then push them to GitHub.
Expand Down

0 comments on commit 6cd177d

Please sign in to comment.