We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include:
- A descriptive title and summary.
- Steps to reproduce the issue.
- Any relevant logs or screenshots
- Search the existing Issues to see if your idea has already been suggested.
- If not, open a new issue and provide:
- A clear and descriptive title.
- A detailed description of the enhancement.
- Any relevant examples or mockups.
- Fork the repository and create your branch from
main. - Follow the coding style and conventions used in the project.
- Ensure your code passes existing tests and add new tests for your changes.
- Submit your pull request, and make sure to:
- Describe the purpose of the PR.
- Reference any related issues.
- Include screenshots or examples if applicable.
If you need help or have questions, feel free to reach out by opening an issue or joining our community chat.
Thank you for contributing!