Contributing Guide
Code of Conduct and Style Guide
Please read our code of conduct and style guide before contributing.
Issues
- Check for existing issues before creating a new one.
- When creating an issue, be clear, provide as much detail as possible and provide examples, when possible.
Pull Requests
Fork and clone the repository.
Set up git submodules:
git submodule update --init
Create a new branch for your changes.
Make your changes and ensure
deno task ok
passes successfully.Commit your changes with clear messages.
Submit a pull request with a clear title and description of your changes and reference any relevant issues.
Examples of good titles:
- fix(http): fix race condition in server
- docs(fmt): update docstrings
- feat(log): handle nested messages
Examples of bad titles:
- fix #7123
- update docs
- fix bugs
Deprecations
See the deprecation policy for how deprecations work.
Start creating a pull request by adding a deprecation notice to the given symbol with the following format, including the removal version and links to any relevant replacement symbols or documentation:
// /sub/foo.ts /** * @deprecated (will be removed in 0.215.0) Use {@linkcode bar} instead. */ export function foo() {}
Submit a pull request starting with the following format:
deprecation(sub): `foo()`
Tests
Use the following convention for test names:
<symbol>() <criteria>
Examples:
- assertEquals() matches when values are equal
- ensureDirSync() creates dir if it does not exist
- chunk() throws on non-naturals