There are two reasons to open an issue:
- Bug report
- Feature request
For bug reports please describe the bug with a clear and concise description, steps to reproduce the behavior (usage example or test), expected behavior, provide OS and Node.js version, you can upload screenshots and any additional context for better understanding.
Since issues on GitHub are intended to be related to problems and feature requests, we recommend not using this medium to simply ask a question Thanks for your understanding!
Before open pull request please follow checklist:
- code is properly formatted (
npm run fmt) - linter and tests show no problems (
npm run check) - tests are added/updated for bug fixes and new features
- update .d.ts typings
- description of changes is added in CHANGELOG.md
By making a contribution to this project, I certify that:
-
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
-
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
-
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
-
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.