Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (19 loc) · 984 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 984 Bytes

Contributing

Contributions are welcome!

Contributions can be made via a Pull Request on GitHub.

Reporting an Issue

Please report issues via the issue tracker on GitHub. For security-related issues, please email the maintainer directly.

Pull Requests

  • Lint & format before committing - Biome

    npm run lint
npm run fmt

  • Add tests where appropriate - Vitest

    npm test

  • Document any change in behaviour - Make sure the README and any other relevant documentation are kept up-to-date.

  • Create topic branches - i.e feature/some-awesome-feature.

  • One pull request per feature

  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.