-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(contributing): add CONTRIBUTING guide
- Loading branch information
1 parent
937538e
commit f300a5a
Showing
1 changed file
with
23 additions
and
0 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 @@ | ||
# How to Contribute | ||
|
||
## Pull Requests | ||
|
||
Repository use the [GitHub flow](https://guides.github.com/introduction/flow/) as main versioning workflow | ||
|
||
1. Fork the repository | ||
2. Create a new branch for each feature, fix or improvement | ||
3. Keep your git history as clean as possible | ||
4. Send a pull request from each feature branch to the **master** branch | ||
|
||
It is very important to separate new features or improvements into separate feature branches, and to send a | ||
pull request for each branch. | ||
|
||
This allow us to review and pull in new features or improvements individually. | ||
|
||
## Style Guide | ||
|
||
All pull requests SHOULD adhere to the [Conventional Commits specification](https://conventionalcommits.org/) | ||
|
||
## License | ||
|
||
You must agree that your patch will be licensed under the MIT License, and when we change the license we will assume that you agreed with the change unless you object to the changes in time. |