24 lines
1.3 KiB
Markdown
24 lines
1.3 KiB
Markdown
|
# Contributing
|
||
|
|
|
||
|
|
Contributions, issues and feature requests are very welcome. If you want improve this cheat sheet or translate it in another language, please consider opening an issue ! We will discuss it with out.
|
||
|
|
|
||
|
|
If you want to contribute you must read and accept out [Code of Conduct](/code-of-conduct)
|
||
|
|
|
||
|
|
## Guidelines
|
||
|
|
|
||
|
|
### General guidelines
|
||
|
|
|
||
|
|
- The master branch is the official document.
|
||
|
|
- All new translations / suggestion should be done in dedicated branch from the `master` branch.
|
||
|
|
- It's a very nice thing to have multiple small commits as you work on the PR. It's easier to review it. Then we will squash it before merging.
|
||
|
|
|
||
|
|
### Commit messages
|
||
|
|
|
||
|
|
This project uses [gitmoji](https://gitmoji.carloscuesta.me/) as commit convention, because it's fun and provides an easy way of identifying the purpose or intention of a commit with only looking at the emojis used. All you just have to do is to find the emoji corresponding to the purpose of your commit in [this list](https://gitmoji.carloscuesta.me/) following by a short message explaining the update. You can also add a description if it's needed. That's all ;)
|
||
|
|
|
||
|
|
https://gitmoji.carloscuesta.me/
|
||
|
|
|
||
|
|
### Adding new translation or having a suggestion
|
||
|
|
|
||
|
|
Ideally you should open a suggestion issue on [GitHub](https://github.com/zenika-open-source/how-to-promote-my-open-source/issues).
|