Thank you for your interest in contributing!
To keep the project stable, readable, and maintainable, please follow the guidelines below.
- Make sure there is an open issue describing the change.
- If not, create one and wait for approval before starting work.
- For large changes, propose your idea first to avoid wasted effort.
- Fork the repository.
- Create a new branch: git checkout -b feature/your-feature-name
- Make your changes.
- Test your changes thoroughly.
- Commit using clear, descriptive messages.
- Follow the existing code style.
- There are no mixins
- Avoid unnecessary dependencies.
- Document new code where needed.
- Do not modify licensing headers.
If your contribution fixes a bug:
- Reference the issue number in your PR.
- Include reproduction steps.
- Add tests if applicable.
For new features:
- Provide a clear explanation of the feature.
- Include usage examples.
- Ensure backward compatibility unless approved otherwise.
- Ensure your branch is up to date with
main. - Open a pull request with:
- A clear title
- A detailed description
- Screenshots/logs if relevant
- Wait for review and requested changes.
- Once approved, it will be merged by a maintainer.
By contributing, you agree that your contributions will be licensed under the same license as the project.
Your contributions help the project grow and improve.