From 43a64813f3759204dea8249149aa1abed67f45e9 Mon Sep 17 00:00:00 2001 From: Shivam Mathur Date: Sun, 22 Sep 2019 14:00:16 +0530 Subject: [PATCH] Improve PR Templates --- .github/PULL_REQUEST_TEMPLATE.md | 34 +++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/FAILING_TEST.md | 21 ++++++++++++ .github/PULL_REQUEST_TEMPLATE/FIX.md | 21 ++++++++++++ .github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md | 21 ++++++++++++ .github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md | 21 ++++++++++++ 5 files changed, 118 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..6cfc53c1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,34 @@ +--- +name: | + 🐞 Failing Test + 🐞 Bug Fix + ⚙ Improvement + 🎉 New Feature +about: You found a bug, have a failing test, want to improve something or add a new feature +labels: bug or enhancement +--- + +## A Pull Request should be associated with an Issue. + +> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs. +> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues, +> and potentially we'll be able to point development in a particular direction. + +Related issue: + +> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md) +> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR + +### Description + +This PR [briefly explain what it does] + +> In case this PR introduced TypeScript/JavaScript code changes: + +- [ ] I have written test cases for the changes in this pull request +- [ ] I have run `npm run format` before the commit. +- [ ] `npm test` returns with no unit test errors. + + \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/FAILING_TEST.md b/.github/PULL_REQUEST_TEMPLATE/FAILING_TEST.md index a2d36fbe..b69150f6 100644 --- a/.github/PULL_REQUEST_TEMPLATE/FAILING_TEST.md +++ b/.github/PULL_REQUEST_TEMPLATE/FAILING_TEST.md @@ -4,6 +4,27 @@ about: You found a bug and have a failing test? labels: bug --- +## A Pull Request should be associated with an Issue. + +> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs. +> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues, +> and potentially we'll be able to point development in a particular direction. + +Related issue: + +> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md) +> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR + +### Description + +This PR [briefly explain what it does] + +> In case this PR introduced TypeScript/JavaScript code changes: + +- [ ] I have written test cases for the changes in this pull request +- [ ] I have run `npm run format` before the commit. +- [ ] `npm test` returns with no unit test errors. + diff --git a/.github/PULL_REQUEST_TEMPLATE/FIX.md b/.github/PULL_REQUEST_TEMPLATE/FIX.md index 4508a07b..3d1bc7e3 100644 --- a/.github/PULL_REQUEST_TEMPLATE/FIX.md +++ b/.github/PULL_REQUEST_TEMPLATE/FIX.md @@ -4,6 +4,27 @@ about: You have a fix for a bug? labels: bug --- +## A Pull Request should be associated with an Issue. + +> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs. +> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues, +> and potentially we'll be able to point development in a particular direction. + +Related issue: + +> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md) +> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR + +### Description + +This PR [briefly explain what it does] + +> In case this PR introduced TypeScript/JavaScript code changes: + +- [ ] I have written test cases for the changes in this pull request +- [ ] I have run `npm run format` before the commit. +- [ ] `npm test` returns with no unit test errors. + diff --git a/.github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md b/.github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md index c7792f77..b1bf337e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md +++ b/.github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md @@ -4,6 +4,27 @@ about: You have some improvement to make setup-php better? labels: enhancement --- +## A Pull Request should be associated with an Issue. + +> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs. +> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues, +> and potentially we'll be able to point development in a particular direction. + +Related issue: + +> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md) +> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR + +### Description + +This PR [briefly explain what it does] + +> In case this PR introduced TypeScript/JavaScript code changes: + +- [ ] I have written test cases for the changes in this pull request +- [ ] I have run `npm run format` before the commit. +- [ ] `npm test` returns with no unit test errors. + diff --git a/.github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md b/.github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md index b39d753d..c8192d78 100644 --- a/.github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md +++ b/.github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md @@ -4,6 +4,27 @@ about: You have implemented some neat idea that you want to make part of setup-p labels: enhancement --- +## A Pull Request should be associated with an Issue. + +> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs. +> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues, +> and potentially we'll be able to point development in a particular direction. + +Related issue: + +> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md) +> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR + +### Description + +This PR [briefly explain what it does] + +> In case this PR introduced TypeScript/JavaScript code changes: + +- [ ] I have written test cases for the changes in this pull request +- [ ] I have run `npm run format` before the commit. +- [ ] `npm test` returns with no unit test errors. +