# Contributing to @panva/jose

Please note we have a [code of conduct][coc], please follow it in all your interactions with the
project.

When contributing to this project, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this project before proposing a change via a Pull
Request. Use (and follow!) the appropriate [Issue Template][new-issue] to do so. A contribution that
implements something non-standard will most likely be dismissed.

## Rules of the discussions

Remember to be very clear and transparent when discussing any issue in the discussions boards. We
ask that you keep the language to English and keep on track with the issue at hand. Lastly, please
be respectful of our fellow contributors and keep an exemplary level of professionalism at all
times.

## Pull Request Checklist

- No additional runtime dependencies unless previously agreed upon
- `npm run lint` passes
- File names must be snake_case.js
- Add tests covering 100% of the library code you are adding or modifying
- Unless previously agreed upon (i.e. fixing a bug) all contributions must be backwards compatible
- Update the documentation
- Do not commit unnecessary whitespace

[coc]: https://github.com/panva/jose/blob/master/CODE_OF_CONDUCT.md
[new-issue]: https://github.com/panva/jose/issues/new/choose
[standard-version]: https://github.com/conventional-changelog/standard-version
