👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to this project. These are just guidelines, not rules, so use your best judgment and feel free to propose changes to this document via a pull request.
If you encounter a bug, please create an issue with as much detail as possible. Include details about your environment, reproduce steps, and the affected component.
If you'd like to see a new feature or function, create an issue with a clear title and description of the feature you'd like to see.
- Fork the repo and create your branch from
main
. - Install all dependencies. ([Installation Procedure])
- If you've added code that should be tested, add tests and ensure they pass. ([Testing Procedure])
- Ensure your code lints (consistency is key).
- Submit a pull request. ([Submit Procedure])