Thank you for contributing! 🎉 Here are some guidelines to contributing to this repository.
- 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 if it still a work in progress, and do not mark it for review. Only open it for review when it is fully finished.
Once you are done implementing the feature, make sure that your code follows the style guide laid out in the README, and all status checks are passing. Fill out the pull request description with as much detail so its clear what changes were made and how it can be tested. Then, mark the pull request as ready for review.
When opening an issue, look to make sure that a similar issue has not already been opened.
When creating an issue, add a label for easier classification. Here are a breakdown of the available labels:
| Label name | Description |
|---|---|
bug | Something isn't working |
core | Core functionality to package |
infra | Supporting tickets for repository |
documentation | An issue with documentation |
hipri | High priority feature |
midpri | Necessary feature |
lowpri | Future features |
duplicate | This issue or pull request already exists |
questions | Further information is requested |