# Contributing

## Issues

* Please file [issues](https://github.com/strangerlabs/webauthn/issues) :)
* When writing a bug report, include relevant details such as platform, version, relevant data, and stack traces
* Ensure to check for existing issues before opening new ones
* Read the documentation before asking questions
* It is strongly recommended to open an issue before hacking and submitting a PR

## Pull requests

### Policy

* We're not presently accepting *unsolicited* pull requests
* Create an issue to discuss proposed features before submitting a pull request
* Create an issue to propose changes of code style or introduce new tooling
* Ensure your work is harmonious with the overall direction of the project
* Ensure your work does not duplicate existing effort
* Keep the scope compact; avoid PRs with more than one feature or fix
* Code review with maintainers is required before any merging of pull requests
* New code must respect the style guide and overall architecture of the project
* Be prepared to defend your work

### Style guide

* [Conventional Changelog](https://github.com/conventional-changelog/conventional-changelog)
* [ECMAScript](https://tc39.github.io/ecma262/)
* [Standard JavaScript](https://standardjs.com)
* [Standard README](https://github.com/RichardLitt/standard-readme)
* [jsdoc](https://jsdoc.app)

### Code reviews

* required before merging PRs
* reviewers MUST run and test the code under review

## Code of conduct

* @strangerlabs/webauthn follows the [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/) Code of Conduct.