First off, thanks for taking the time to contribute! It's people like you that make this project great.
- Check if it has already been reported in the Issues tab.
- Use the Bug Report template when opening a new issue.
- Provide a clear "Steps to Reproduce" section.
- Open an issue using the Feature Request template.
- Explain why this enhancement would be useful to most users.
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- Ensure the test suite passes.
- Issue that PR!
To keep our codebase clean and consistent, we use an .editorconfig file located in the root of every repository.
- Automated Formatting: Please ensure your IDE (VS Code, IntelliJ, Sublime, etc.) has an EditorConfig plugin installed. This will automatically set your indentation, line endings, and character encoding to match our standards.
- Pre-commit: Before submitting a Pull Request, please ensure your code doesn't have trailing whitespace and follows the rules defined in the
.editorconfig. - Keep pull requests small and focused on a single change.