Skip to content

Commit

Permalink
Add commit convention guidelines to CONTRIBUTING.md (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
nick-y-ito authored Oct 26, 2023
1 parent ffaf57f commit e4b0107
Showing 1 changed file with 34 additions and 2 deletions.
36 changes: 34 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Thank you for your interest in contributing to Nishiki! This document outlines t
- [Branch Naming Conventions](#branch-naming-conventions)
- [Examples](#examples)
- [Testing](#testing)
- [Commit Convention](#commit-convention)
- [Pull Requests](#pull-requests)
- [For Team Members:](#for-team-members)
- [For External Contributors:](#for-external-contributors)
Expand Down Expand Up @@ -46,14 +47,44 @@ Thank you for your interest in contributing to Nishiki! This document outlines t
- Make sure all tests pass locally and on the CI server.
- Update existing tests if you modify code that affects them.

## Commit Convention

Before you create a Pull Request, please check whether your commits comply with
the commit conventions used in this repository.

When you create a commit we kindly ask you to follow the convention
`category(scope or module): message` in your commit message while using one of
the following categories:

- `feat / feature`: all changes that introduce completely new code or new
features
- `fix`: changes that fix a bug (ideally you will additionally reference an
issue if present)
- `refactor`: any code related change that is not a fix nor a feature
- `docs`: changing existing or creating new documentation (i.e. README, docs for
usage of a lib or cli usage)
- `build`: all changes regarding the build of the software, changes to
dependencies or the addition of new dependencies
- `test`: all changes regarding tests (adding new tests or changing existing
ones)
- `ci`: all changes regarding the configuration of continuous integration (i.e.
github actions, ci system)
- `chore`: all changes to the repository that do not fit into any of the above
categories

If you are interested in the detailed specification you can visit
https://www.conventionalcommits.org/ or check out the
[Angular Commit Message Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines).

## Pull Requests

### For Team Members:

1. Create a new branch from the `develop` branch, or from the `main` branch if you're working on a hotfix.
2. Follow the [Branch Naming Conventions](#branch-naming-conventions) while naming your branch.
3. Work on your changes locally.
4. Ensure that all [tests](#testing) pass.
4. Commit your changes, ensuring to follow the project's [commit message conventions](#commit-convention).
5. Ensure that all [tests](#testing) pass.
6. Push your branch to the repository.
7. Create a Pull Request against the original branch you branched from.
8. Await code review, and address any comments as necessary.
Expand All @@ -65,7 +96,8 @@ Thank you for your interest in contributing to Nishiki! This document outlines t
3. Create a new branch from the `develop` branch on your fork.
4. Follow the [Branch Naming Conventions](#branch-naming-conventions) while naming your branch.
5. Work on your changes locally.
6. Ensure that all [tests](#testing) pass.
6. Commit your changes, ensuring to follow the project's [commit message conventions](#commit-convention).
7. Ensure that all [tests](#testing) pass.
8. Push your branch to your forked repository.
9. Create a Pull Request against the `develop` branch of the original repository.
10. Await code review, and address any comments as necessary.

0 comments on commit e4b0107

Please sign in to comment.