Skip to content

Commit 6bb3b55

Browse files
author
David Hayes
committed
chore: Add guidelines around conventional commits to docs.
Updated README and CONTRIBUTING docs to include guidelines around conventional commits.
1 parent bbb06c2 commit 6bb3b55

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,15 @@ We welcome any contributions that can help make this a more useful repository in
1010
- Documentation improvements
1111
- Creating issues for bugs and participating when the solution/fix needs to be tested
1212
- Pull Requests for features, fixes, etc.
13+
14+
## Formatting Commit Messages
15+
16+
This repository uses conventional commits to format commit messages. This allows us to automatically generate changelogs and release notes. Please see [this link](https://www.conventionalcommits.org/en/v1.0.0/) for more information on how to format your commit messages.
17+
18+
Specifically, we use the following format:
19+
20+
- `feat: <description>` for new features
21+
- `fix: <description>` for bug fixes
22+
- `chore: <description>` for changes that don't affect the codebase
23+
24+
One of those should be the first line in your commit message. If you need to add more detail, you can add a blank line and then add more detail.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,3 +71,5 @@ If you create a logger with the log level `error`, it will only log messages tha
7171
## Local development
7272

7373
To work on this locally, clone it and run `npm install`. You should be good to go.
74+
75+
Be sure to read CONTRIBUTING.md for guidelines on contributing to this repo.

0 commit comments

Comments
 (0)