Thank you for your interest in contributing! 🎉
We welcome all contributions, including bug reports, feature requests, documentation improvements, and code changes.
-
Fork the repository and create your branch from
main. -
Make your changes with clear, concise commits. Follow the conventional commit spec.
-
Add or update tests to cover your changes.
-
Run lint and tests to ensure code quality:
pnpm run lint pnpm run test -
Update documentation if your change affects usage or public APIs.
-
Open a pull request using the provided template. Be sure to:
- Clearly describe your change and why it is needed.
- Link to any related issues (e.g.,
Fixes #123). - Check all items in the pull-request checklist:
- Code is up-to-date with the
mainbranch -
pnpm run lintpasses with this change -
pnpm run testpasses with this change - This pull request links relevant issues as
Fixes #0000 - There are new or updated unit tests validating the change
- Documentation has been updated to reflect this change
- The new commits follow conventions outlined in the conventional commit spec
- Code is up-to-date with the
This project follows a Code of Conduct. By participating, you are expected to uphold this code.
If you have questions, open an issue or start a discussion. Thank you for helping make this project better!