foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-26 09:10:40 -05:00
Code Issues Packages 1 Wiki Activity

chore: update contributing.md and PR template (#7820)

Browse source
This commit is contained in:
Bartek Iwańczuk 2020-10-06 10:40:48 +02:00 committed by GitHub
parent c7c7677825
commit 6b8aef5103
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 40 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -1,4 +1,22 @@
<!--
Before submitting a PR, please read
https://github.com/denoland/deno/blob/master/docs/contributing.md
1. Give the PR a descriptive title.
Examples of good title:
- fix(std/http): Fix race condition in server
- docs(console): Update docstrings
- feat(doc): Handle nested reexports
Examples of bad title:
- fix #7123
- update docs
- fix bugs
2. Ensure there is a related issue and it is referenced in the PR text.
3. Ensure there are tests that cover the changes.
4. Ensure `cargo test` passes.
5. Ensure `./tools/format.py` passes without changing files.
6. Ensure `./tools/lint.py` passes.
-->

27
docs/contributing.md
View file

@ -9,6 +9,9 @@
- 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](https://www.rust-lang.org/policies/code-of-conduct)
(CoC). Have a problem? Email ry@tinyclouds.org.
@ -22,11 +25,25 @@ Instructions on how to build from source can be found
Before submitting, please make sure the following is done:
1. That there is a related issue and it is referenced in the PR text.
2. There are tests that cover the changes.
3. Ensure `cargo test` passes.
4. Format your code with `./tools/format.py`.
5. Make sure `./tools/lint.py` passes.
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
2. Ensure there is a related issue and it is referenced in the PR text.
3. Ensure there are tests that cover the changes.
4. Ensure `cargo test` passes.
5. Ensure `./tools/format.py` passes without changing files.
6. Ensure `./tools/lint.py` passes.
## Changes to `third_party`