From 3fdcfea3d24f8d647d805af28d1413754c954c77 Mon Sep 17 00:00:00 2001 From: onlinejudge95 Date: Tue, 28 Jan 2020 01:16:54 +0530 Subject: [PATCH 1/6] Mandates referencing issue in PR --- .github/pull_request_template.md | 1 + CONTRIBUTING.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2f130896ebe3..0020c9669830 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -17,3 +17,4 @@ * [ ] All function parameters and return values are annotated with Python [type hints](https://docs.python.org/3/library/typing.html). * [ ] All functions have [doctests](https://docs.python.org/3/library/doctest.html) that pass the automated testing. * [ ] All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation. +* [ ] I am referencing the issue with this PR for auto cleanup. For eg. `fixes: #{$ISSUE_NO}` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ce2f03886e01..1792d581c289 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,6 +25,8 @@ We appreciate any contribution, from fixing a grammar mistake in a comment to im Your contribution will be tested by our [automated testing on Travis CI](https://travis-ci.org/TheAlgorithms/Python/pull_requests) to save time and mental energy. After you have submitted your pull request, you should see the Travis tests start to run at the bottom of your submission page. If those tests fail, then click on the ___details___ button try to read through the Travis output to understand the failure. If you do not understand, please leave a comment on your submission page and a community member will try to help. +It would help us a lot in cleanup if you are mentioning your Issue no. in your Pull Request. For eg. Adding this text(`fixes: #{$ISSUE_NO}`) as a comment in your PR + #### Coding Style We want your work to be readable by others; therefore, we encourage you to note the following: From eaba3b1dd871cd98985bb8ba10d61ef0564eacb0 Mon Sep 17 00:00:00 2001 From: John Law Date: Tue, 28 Jan 2020 04:10:51 +0800 Subject: [PATCH 2/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1792d581c289..66fb0fe945cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ We appreciate any contribution, from fixing a grammar mistake in a comment to im Your contribution will be tested by our [automated testing on Travis CI](https://travis-ci.org/TheAlgorithms/Python/pull_requests) to save time and mental energy. After you have submitted your pull request, you should see the Travis tests start to run at the bottom of your submission page. If those tests fail, then click on the ___details___ button try to read through the Travis output to understand the failure. If you do not understand, please leave a comment on your submission page and a community member will try to help. -It would help us a lot in cleanup if you are mentioning your Issue no. in your Pull Request. For eg. Adding this text(`fixes: #{$ISSUE_NO}`) as a comment in your PR +It would help us a lot in cleanup if you are mentioning your __issue number__ in your pull request, for example, adding the text: `fixes: #123` or `closes: #5678` as a comment in your pull request. #### Coding Style From c8d14205c07ec7ad9a5486d9b8a88f856307700f Mon Sep 17 00:00:00 2001 From: John Law Date: Tue, 28 Jan 2020 04:12:34 +0800 Subject: [PATCH 3/6] Update pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0020c9669830..5e9969960ed4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -17,4 +17,4 @@ * [ ] All function parameters and return values are annotated with Python [type hints](https://docs.python.org/3/library/typing.html). * [ ] All functions have [doctests](https://docs.python.org/3/library/doctest.html) that pass the automated testing. * [ ] All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation. -* [ ] I am referencing the issue with this PR for auto cleanup. For eg. `fixes: #{$ISSUE_NO}` +* [ ] I am referencing an issue with this PR for auto cleanup. For example, `fixes: #1234` or `closes: #567`. From 143a9ccceeaaa96bf15a4de89bd66632ed70011c Mon Sep 17 00:00:00 2001 From: John Law Date: Tue, 28 Jan 2020 04:24:35 +0800 Subject: [PATCH 4/6] Update pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5e9969960ed4..8bf0fcdd3be2 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -17,4 +17,4 @@ * [ ] All function parameters and return values are annotated with Python [type hints](https://docs.python.org/3/library/typing.html). * [ ] All functions have [doctests](https://docs.python.org/3/library/doctest.html) that pass the automated testing. * [ ] All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation. -* [ ] I am referencing an issue with this PR for auto cleanup. For example, `fixes: #1234` or `closes: #567`. +* [ ] I am referencing an issue in this PR or in the commit message for auto cleanup. For example, `fixes: #1234` or `closes: #567`. From 299a8aa714dd9541b7528d6e3f1509fea99a0518 Mon Sep 17 00:00:00 2001 From: Christian Clauss Date: Mon, 27 Jan 2020 21:54:12 +0100 Subject: [PATCH 5/6] Update pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8bf0fcdd3be2..3b7d70fed373 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -17,4 +17,4 @@ * [ ] All function parameters and return values are annotated with Python [type hints](https://docs.python.org/3/library/typing.html). * [ ] All functions have [doctests](https://docs.python.org/3/library/doctest.html) that pass the automated testing. * [ ] All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation. -* [ ] I am referencing an issue in this PR or in the commit message for auto cleanup. For example, `fixes: #1234` or `closes: #567`. +* [ ] If this issues resolves an open issue then the commit message contains `Fixes: #{$ISSUE_NO}` for auto cleanup. From 5428114da1b941d62750a68025467e730b78732d Mon Sep 17 00:00:00 2001 From: Christian Clauss Date: Mon, 27 Jan 2020 21:54:40 +0100 Subject: [PATCH 6/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 66fb0fe945cb..11b956d73193 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ We appreciate any contribution, from fixing a grammar mistake in a comment to im Your contribution will be tested by our [automated testing on Travis CI](https://travis-ci.org/TheAlgorithms/Python/pull_requests) to save time and mental energy. After you have submitted your pull request, you should see the Travis tests start to run at the bottom of your submission page. If those tests fail, then click on the ___details___ button try to read through the Travis output to understand the failure. If you do not understand, please leave a comment on your submission page and a community member will try to help. -It would help us a lot in cleanup if you are mentioning your __issue number__ in your pull request, for example, adding the text: `fixes: #123` or `closes: #5678` as a comment in your pull request. +Please help us keep our issue list small by adding fixes: #{$ISSUE_NO} to the commit message of pull requests that resolve open issues. GitHub will use this tag to auto close the issue when the PR is merged. #### Coding Style