foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-14 16:33:45 -05:00
Code Issues Wiki Activity
denoland-deno/docs/contributing.md

2.5 KiB
Raw Blame History

Contributing

  • 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.

  • Please be professional in the forums. We follow Rust's code of conduct (CoC). Have a problem? Email ry@tinyclouds.org.

Development

Instructions on how to build from source can be found here.

Submitting a Pull Request

Before submitting, please make sure the following is done:

  1. 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
  1. Ensure there is a related issue and it is referenced in the PR text.
  2. Ensure there are tests that cover the changes.
  3. Ensure cargo test passes.
  4. Ensure ./tools/format.js passes without changing files.
  5. Ensure ./tools/lint.js passes.

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 PR #671.

Releases

Summary of the changes from previous releases can be found here.

Documenting APIs

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.

Utilize JSDoc

All publicly exposed APIs and types, both via the deno module as well as the global/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/