Skip to content

Commit

Permalink
docs: Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
fix #251

Signed-off-by: Antonette Caldwell <[email protected]>
  • Loading branch information
nebula-aac committed Dec 20, 2023
1 parent 936374e commit 5dc0a45
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,21 @@ For example:
- `feat(auth): add user authentication feature`
- `fix(ui): resolve styling issue in the header`

Please ensure that your commits adhere to this format to maintain a clear and organized commit history.
Please ensure that your commits adhere to this format to maintain a clear and organized commit history. This repo also uses `commitizen` and `commitlint` to make sure that you are adhering the rules in writing a commit.

To write a commit message for this repo, each commit should have the following above, which includes the type, an optional scope, and a descriptive message.

- `style`: Since we're using `prettier` and `eslint` to fix formatting and linting styles, you can write your commit message like so:

`style(repo): use prettier and eslint to lint and format`

or `style: format files`.

The above will just write a commit message without a scope.

- `feat`: When using this commit type, we're introducing a new feature into the repo. This feature has never been used, and will require a `minor` version to be used.
- `fix`: When usin this commit type, we're introducing backward compatibility fixes to the existing repo. To help have a clean git commit, it would be better to create new features, and then work on fixing them to make meaningful releases.
- `docs`: This is specific to any of the documentations, like Markdown files.

#### Tests

Expand Down

0 comments on commit 5dc0a45

Please sign in to comment.