This project is released under the MPL 2.0 license. Before implementing new features and changes, feel free to submit an issue. We're going to talk here 😜.
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
We have an official Discord server where we can give helpful advices if you have questions.
- Fork this repository.
- Create a new branch with the feature name. (Eg: feature/chat-support, hotfix/website-header)
- Make your changes.
- Commit your changes. Please follow the styleguides
- Push your changes.
- Submit your pull request.
We use GitFlow so unless your PR is a hotfix, your feature branch must be created from the develop branch.
TIP: This Git extension makes Git Flow a piece of cake. GitKraken also has built-in support for GitFlow
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - ⚡
:zap:when improving performance - 📝
:pencil:when writing docs - 🐧
:penguin:when fixing something on Linux - 🍎
:apple:when fixing something on macOS - 🏁
:checkered_flag:when fixing something on Windows - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 💚
:green_heart:when fixing the CI build - ✅
:white_check_mark:when adding or updating tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 🚨
:rotating_light:when removing linter warnings
- 🎨
- Full emoji reference in gitmoji