diff options
| author | Bartek Iwańczuk <biwanczuk@gmail.com> | 2020-10-06 10:40:48 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-06 10:40:48 +0200 |
| commit | 6b8aef5103e6c77cc89ae4c7da959b39b1c4af4a (patch) | |
| tree | 2168235d90d375c48f067eeac24147ea5452c005 | |
| parent | c7c767782538243ded64742dca9b34d6af74d62d (diff) | |
chore: update contributing.md and PR template (#7820)
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 18 | ||||
| -rw-r--r-- | docs/contributing.md | 27 |
2 files changed, 40 insertions, 5 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3147bfbc4..ad1556aa9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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. --> diff --git a/docs/contributing.md b/docs/contributing.md index 7bbc186d0..daabcf055 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -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` |