Thank you for contributing! 🎉 Here are some guidelines to contributing to this repository. These are guidelines, not rules, but please try your best to adhere to them!
- Start commit message with uppercase letter
- Use present tense ("Add feature" not "Added feature")
- Use imperative mood ("Move cursor to..." not "Moves cursor to...")
- Reference issues and pull requests
When initially opening a pull request, please open it in draft mode, and do not mark it for review. Please fill out the template with as much detail as you can.
Once you are done implementing the feature, make sure that your code follows the style guides laid out in the README, and all status checks are passing. Then, mark the pull request as ready for review.
Start pull request titles with emojis! Here's a list of some that you can use, or you can choose a random one:
- 🎨
:art:when improving the format/structure of the code - 📖
:book:when writing docs - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - ✅
:white_check_mark:when adding tests - ⬆️
:arrow_up:when upgrading dependencies - 👕
:shirt:when removing linter warnings
When opening an issue, look to make sure that a similar issue has not already been opened. This is to avoid clutter.