Development of this file is ongoing.
Thanks for helping to improve this project! All Contributions are welcome, regardless of skill or experience level.
A quickstart checklist for all projects.
- Javascript only.
- Typscript types are managed separately in DefinitelyTyped.
- No compiling, transpiling or build system in the primary codebase - just plain, native JS.
- Coding style: StandardJS.
- ECMAScript modules with a CommonJS distribution.
- Support Node.js >= v12.17.
- Isomorphic where possible.
- Atomic, reversable commits preferred.
- Any descriptive commit message is fine.
- Full test coverage expected.
- API documentation expected.
- Github CI testing on node 12, 14 and 16.
- MIT licence.
Guidance when submitting work.
- All Pull Requests are welcome - large or small.
- Even if a PR is not approved it could still influence direction or highlight wider concerns.
- Planned work must fit the project mandate.
- Planned work must benefit at least the majority of users.
- Niche, edge-case features might be better suited in a wrapper, plugin or extension.
- Don't worry if your first PR takes a little longer to review and approve, second and third PRs will sail through.
Checklist before submitting a PR. If you are unsure about any of these points don't be shy to ask before submitting.
- You have conviction in the solution proposed
- You have followed the guidance for submitting work
- It is complete to the best of your knowledge
- You have added tests
- 100% branch coverage preferred
- All expected input/usage scenarios covered
- Negative usage scenarios covered (e.g. handling invalid input)
- You have made required changes to the API docs or readme
Please ask in an issue or discussion thread.