-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b66c0ef
commit 352ce29
Showing
5 changed files
with
450 additions
and
2,758 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Contributing Guidelines | ||
|
||
## Commit Messages | ||
|
||
This repository uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and [commitlint](https://commitlint.js.org) | ||
to standardize the commit messages. | ||
|
||
## Development Flow | ||
|
||
This repository follows a gitflow-style development. | ||
|
||
The `main`/`master` branch is locked, and only allows pull requests. | ||
Any change in the `main`/`master` branch gets automatically released via [semantic-release](https://github.com/semantic-release/semantic-release). | ||
|
||
The `next` branch gets merged into `main`/`master` on an unscheduled basis. | ||
|
||
Any change to the repository requires a new branch from the `next` branch, which then gets merged back into it with a pull request. | ||
|
||
The pull request title must follow the same rules as commit messages and it gets linted. | ||
|
||
The following diagram visualizes the development flow: | ||
|
||
![development flow](./.github/development-flow.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.