🎉 First of all, thanks for taking the time to contribute! 👍
The following is a set of guidelines for contributing to engineering-manager-tools and its packages. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a merge request.
engineering-manager-tools and all libraries can be developed locally.
The process described here has several goals:
- Maintain engineering-manager-tools's quality
- Fix problems that are important to EMs
Please follow these steps to help with a better readability:
- The branch name should follow the following format:
ticketId_ticket-titlefor example :Ticket-11145_improve-test-coverage - The tag for QA & production should have a description for easier readability
- follow the style guide
- Please assign one of the maintainers from the list below to the merge request
| Name | Role |
|---|---|
| Jaouher Kharrat | Owner |
WIP
- 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 merge requests liberally after the first line
- Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 🚱
:non-potable_water:when plugging memory leaks - 📝
:memo:when writing docs - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 👕
:shirt:when removing linter warnings
- 🎨