👍🎉 First off, thanks for taking the time to consider making acontribution! 🎉👍
The following is a set of guidelines for contributing to Gwion. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Just Fill out the required template.
Note: If you find a Closed issue that seems like it is the same thing that you"re experiencing, open a new issue and include a reference to the original issue in the body of your new one.
- Capitalize first letter
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Dot not add dot at the end
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- When only changing documentation, include
[ci skip]in the commit description - Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 💣
:bomb:when plugging memory leaks - 📖
:book:when writing docs - 🐧
:penguin:when fixing OS specific stuff - 🐛
:bug:when fixing a bug - 🔥
:fire:when adding/(re)moving source files - 🔧
:wrench:when fixing build system (including CI) - ✅
:white_check_mark:when working on tests - 🔒
:lock:when dealing with security - 👕
:shirt:when enforcing style - 🎅
:santa:when updating plugins - 🚗
:car:when updating drivers
- 🎨
Names should be self explanatory look here for an up to date list.