Skip to content

Commit

Permalink
docs: Add commit message standards to contrib docs
Browse files Browse the repository at this point in the history
Remove similar section from maintainer docs
  • Loading branch information
arusso committed Apr 5, 2023
1 parent 9ac386d commit 68117e4
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 14 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,33 @@ This section guides you through making a successful pull request.

* Someone will review your PR and ensure it meets these guidelines. If it does
not, we will ask you to fix the identified issues.

### Commit Messages

Commit subjects should begin with the following prefix `<type>:`, where type is
one of the following change types:

- `feat` adds a new feature or expands upon existing behavior
- `fix` for changes that resolve an error in our code
- `docs` for documentation updates
- `chore` for changes related to project maintenance, such as github actions or linter configurations.
- `revert` for a commit that reverts another commit
- `test` for adding missing tests

When multiple change types are present (ie. a new feature is created and as a result fixes a bug), you should use `feat`.

If a change addresses one or more issues, be sure and include `Closes #1, #2,
...` as a dedicated line at the end of your commit body.

An example commit may look like:

```
feat: Add support for a custom command channel size
Create an additional functional option `WithCommandChanSize(int)` that
may be passed into `NewClient(...)` that lets the user specify the
size of the channel used to hold incoming commands to be processed. This
may be useful to expand for high-volume bots.
Closes #319
```
16 changes: 2 additions & 14 deletions MAINTAINING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,5 @@ those that start with `fix:` will be grouped into a "Bug fixes" section. Commits
that begin with `chore:` or `docs:` will be excluded, and all others will be
added to an "Others" section in the changelog.

When reviewing pull requests or committing code, it is strongly encouraged to
use one of the aformentioned prefixes so that changelogs are nicely formatted
and organized.

## Commit Messages

To maintain a tidy changelog on release, we should encourage the use of the
following commit subject prefixes (see the Changelogs for details on how they
are used)

- `feat`: New features
- `fix`: Bug fixes
- `docs`: Usage documentation changes (ie. examples, README)
- `chore`: Housekeeping taks that don't touch code or usage docs
For more details on commit message formatting see the
[CONTRIBUTING](./CONTRIBUTING.md) doc.

0 comments on commit 68117e4

Please sign in to comment.