-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: improve contribution guideline [skip ci]
- Loading branch information
1 parent
a5ca7cf
commit b9676e6
Showing
2 changed files
with
54 additions
and
11 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 |
---|---|---|
@@ -1,6 +1,24 @@ | ||
## Contribution guideline | ||
|
||
1. Create an issue | ||
2. Fork the repository | ||
3. Do your magik | ||
4. Open a pull request (please, put the link to previously opened issue in it's title) | ||
### Contributing | ||
You can contribute by: | ||
- Reporting issues | ||
- Suggesting new features and enhancements | ||
- Improving documentation | ||
|
||
For **minor** changes you can just send a PR without opening linked issue. | ||
|
||
For **major** changes open an issue. | ||
|
||
### Commits and PRs | ||
I highly encourage using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/ "conventional commits") style in commit messages. | ||
|
||
For PR titles it is *required* to use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/ "conventional commits") style titles. | ||
|
||
You can use any of these prefixes: | ||
- fix | ||
- feat | ||
- chore | ||
- refactor | ||
- test | ||
- ci |
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