Read the style guide.
Please don't make the benchmarks worse.
Ask for help in the community chat room.
If you are going to work on an issue, mention so in the issue comments before you start working on the issue.
If you are going to work on a new feature, create an issue and discuss with other contributors before you start working on the feature.
Instructions on how to build from source can be found here.
Submitting a Pull Request
Before submitting, please make sure the following is done:
- Give the PR a descriptive title.
Examples of good PR title:
- fix(std/http): Fix race condition in server
- docs(console): Update docstrings
- feat(doc): Handle nested re-exports
Examples of bad PR title:
- fix #7123
- update docs
- fix bugs
- Ensure there is a related issue and it is referenced in the PR text.
- Ensure there are tests that cover the changes.
./tools/format.jspasses without changing files.
Adding Ops (aka bindings)
We are very concerned about making mistakes when adding new APIs. When adding an Op to Deno, the counterpart interfaces on other platforms should be researched. Please list how this functionality is done in Go, Node, Rust, and Python.
As an example, see how
Deno.rename() was proposed and added in
Summary of the changes from previous releases can be found here.
It is important to document public APIs and we want to do that inline with the code. This helps ensure that code and documentation are tightly coupled together.
All publicly exposed APIs and types, both via the
deno module as well as the
window namespace should have JSDoc documentation. This documentation is
parsed and available to the TypeScript compiler, and therefore easy to provide
further downstream. JSDoc blocks come just prior to the statement they apply to
and are denoted by a leading
/** before terminating with a
*/. For example:
/** A simple JSDoc comment */ export const FOO = "foo";
Find more at: https://jsdoc.app/