summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYoshiya Hinosawa <stibium121@gmail.com>2018-09-10 00:24:11 +0900
committerRyan Dahl <ry@tinyclouds.org>2018-09-09 12:08:40 -0400
commit8020f5fc0b27bf229544461ab885494233e0e4ef (patch)
treeef5690bdfdfddccaf9f08d39a0a6ea3d046fab5c
parentb7ebc1b69940906966e620424281dbb8f3cf8abd (diff)
docs: add contributing guide
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md9
-rw-r--r--README.md10
2 files changed, 19 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..7e8086c0c
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,9 @@
+<!--
+
+Thank you for your pull request. Before submitting, please make sure the following is done.
+
+1. Ensure ./tools/test.py passes.
+2. Format your code with ./tools/format.py
+3. Make sure ./tools/lint.py passes.
+
+-->
diff --git a/README.md b/README.md
index 8edfacc6f..00809b18d 100644
--- a/README.md
+++ b/README.md
@@ -119,3 +119,13 @@ Other useful commands:
./third_party/depot_tools/gn help
Env vars: `DENO_BUILD_MODE`, `DENO_BUILD_PATH`, `DENO_BUILD_ARGS`.
+
+## Contributing
+
+1. Fork [this repository](https://github.com/denoland/deno) and create your branch from `master`.
+2. Make your change.
+3. Ensure `./tools/test.py` passes.
+4. Format your code with `./tools/format.py`.
+5. Make sure `./tools/lint.py` passes.
+6. Send a pull request.
+7. Sign the [CLA](https://cla-assistant.io/denoland/deno), if you haven't already.