To collaborate with our project, it's necessary to follow this guideline:
- 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
- Create commities and variables names on the code only in English
- Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🚀
:rocket:when improving performance - 💡
:bulb:new idea - 🚱
:non-potable_water:when plugging memory leaks - 📝
:memo: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 - ➕
:heavy_plus_sign:when adding feature - 🔥
:fire:when removing code or files - 💚
:green_heart:when fixing the CI build - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 🚧
:construction:work in progress
- 🎨
- The commit structure will be:
Message :emoji: body Signed-off-by: Author Name <[email protected]>
- The PR message must be like that
Message body Signed-off-by: Author Name <[email protected]>