From 175561bf3685d247dd901acfd69bbca901be62c1 Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Fri, 9 Jun 2023 19:38:16 +0300 Subject: [PATCH] docs: update CONTRIBUTING.md (#7937) --- docs/CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index af8f0b37c4..da8a73b4c6 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -225,8 +225,8 @@ characters long (no more than 72). Examples: -- Good: `feat(api): Add feature X` -- Bad: `feat(api): Added feature X` (past tense) +- Good: `feat(api): add feature X` +- Bad: `feat(api): added feature X` (past tense) A good rule of thumb for writing good commit messages is to recite: [If applied, this commit will ...](https://reflectoring.io/meaningful-commit-messages/). @@ -236,7 +236,7 @@ A good rule of thumb for writing good commit messages is to recite: [If applied, Breaking changes can be triggered in two ways: -- Add `!` to the commit message title, e.g. `feat(api)!: Remove deprecated endpoint /test` +- Add `!` to the commit message title, e.g. `feat(api)!: remove deprecated endpoint /test` - Add the [`release/breaking`](https://github.com/coder/coder/issues?q=sort%3Aupdated-desc+label%3Arelease%2Fbreaking) label to a PR that has, or will be, merged into `main`. ### Security