From a0468e956b740938605d5cf75d9d8a93be57cebc Mon Sep 17 00:00:00 2001 From: Arjun Savel <35353555+arjunsavel@users.noreply.github.com> Date: Wed, 8 Jul 2020 10:55:10 -0700 Subject: [PATCH 1/4] Create comment_PR.yml --- .github/workflows/comment_PR.yml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .github/workflows/comment_PR.yml diff --git a/.github/workflows/comment_PR.yml b/.github/workflows/comment_PR.yml new file mode 100644 index 0000000..fedd61c --- /dev/null +++ b/.github/workflows/comment_PR.yml @@ -0,0 +1,32 @@ +name: comment-on-pr example +on: pull_request +jobs: + review: + name: PR review + runs-on: ubuntu-latest + steps: + - name: comment PR + uses: unsplash/comment-on-pr@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + msg: "Before a PR is accepted, it must meet the following criteria: \n + [ ] Is the necessary information provided? \n + [ ] Does the PR have a complete description? Does it explain what the PR is attempting to do/fix, does it explain how it does this? \n + [ ] Is there an explanation of why this PR is needed? \n + [ ] Please use the following PR template: https://github.com/tardis-sn/tardis/blob/master/.github/PULL_REQUEST_TEMPLATE.md \n + [ ] Is this a duplicate PR? \n + [ ] If a new PR is clearly a duplicate, ask how this PR is different from the original PR? \n + [ ] If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue. \n + [ ] Does it pass existing tests and are new tests provided if required? \n + [ ] The test coverage should not decrease, and for new features should be at or very close to 100%. \n + [ ] Is the code properly documented? \n + [ ] If this modifies existing code, then the docs should be updated. If this adds a new feature, additional documentation should be created. \n + [ ] Sphinx and docstrings in the code (in numpydoc format) \n + [ ] Does this conform to PEP 8 and the TARDIS style guidelines? \n + [ ] Does the PR fix the problem it describes? \n + [ ] Make sure it doesn’t e.g. just fix the problem for a specific case \n + [ ] Is this the best way of fixing the problem? \n + [ ] Is the code tidy? \n + [ ] No unnecessary print lines or code comments \n" + check_for_duplicate_msg: true # this is only commented once From 10eb8dd9ed634f96275eef9a207c1252b7ea305e Mon Sep 17 00:00:00 2001 From: Arjun Savel <35353555+arjunsavel@users.noreply.github.com> Date: Wed, 8 Jul 2020 10:57:44 -0700 Subject: [PATCH 2/4] Update comment_PR.yml --- .github/workflows/comment_PR.yml | 36 ++++++++++++++++---------------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/.github/workflows/comment_PR.yml b/.github/workflows/comment_PR.yml index fedd61c..3ce88e8 100644 --- a/.github/workflows/comment_PR.yml +++ b/.github/workflows/comment_PR.yml @@ -11,22 +11,22 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: msg: "Before a PR is accepted, it must meet the following criteria: \n - [ ] Is the necessary information provided? \n - [ ] Does the PR have a complete description? Does it explain what the PR is attempting to do/fix, does it explain how it does this? \n - [ ] Is there an explanation of why this PR is needed? \n - [ ] Please use the following PR template: https://github.com/tardis-sn/tardis/blob/master/.github/PULL_REQUEST_TEMPLATE.md \n - [ ] Is this a duplicate PR? \n - [ ] If a new PR is clearly a duplicate, ask how this PR is different from the original PR? \n - [ ] If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue. \n - [ ] Does it pass existing tests and are new tests provided if required? \n - [ ] The test coverage should not decrease, and for new features should be at or very close to 100%. \n - [ ] Is the code properly documented? \n - [ ] If this modifies existing code, then the docs should be updated. If this adds a new feature, additional documentation should be created. \n - [ ] Sphinx and docstrings in the code (in numpydoc format) \n - [ ] Does this conform to PEP 8 and the TARDIS style guidelines? \n - [ ] Does the PR fix the problem it describes? \n - [ ] Make sure it doesn’t e.g. just fix the problem for a specific case \n - [ ] Is this the best way of fixing the problem? \n - [ ] Is the code tidy? \n - [ ] No unnecessary print lines or code comments \n" + - [ ] Is the necessary information provided? \n + - [ ] Does the PR have a complete description? Does it explain what the PR is attempting to do/fix, does it explain how it does this? \n + - [ ] Is there an explanation of why this PR is needed? \n + - [ ] Please use the following PR template: https://github.com/tardis-sn/tardis/blob/master/.github/PULL_REQUEST_TEMPLATE.md \n + - [ ] Is this a duplicate PR? \n + - [ ] If a new PR is clearly a duplicate, ask how this PR is different from the original PR? \n + - [ ] If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue. \n + - [ ] Does it pass existing tests and are new tests provided if required? \n + - [ ] The test coverage should not decrease, and for new features should be at or very close to 100%. \n + - [ ] Is the code properly documented? \n + - [ ] If this modifies existing code, then the docs should be updated. If this adds a new feature, additional documentation should be created. \n + - [ ] Sphinx and docstrings in the code (in numpydoc format) \n + - [ ] Does this conform to PEP 8 and the TARDIS style guidelines? \n + - [ ] Does the PR fix the problem it describes? \n + - [ ] Make sure it doesn’t e.g. just fix the problem for a specific case \n + - [ ] Is this the best way of fixing the problem? \n + - [ ] Is the code tidy? \n + - [ ] No unnecessary print lines or code comments \n" check_for_duplicate_msg: true # this is only commented once From 5038ab067531bd4d0f194c9fa4beb3154cb8b4be Mon Sep 17 00:00:00 2001 From: Arjun Savel <35353555+arjunsavel@users.noreply.github.com> Date: Wed, 8 Jul 2020 11:00:05 -0700 Subject: [PATCH 3/4] Update comment_PR.yml --- .github/workflows/comment_PR.yml | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/workflows/comment_PR.yml b/.github/workflows/comment_PR.yml index 3ce88e8..eabf8a3 100644 --- a/.github/workflows/comment_PR.yml +++ b/.github/workflows/comment_PR.yml @@ -12,21 +12,21 @@ jobs: with: msg: "Before a PR is accepted, it must meet the following criteria: \n - [ ] Is the necessary information provided? \n - - [ ] Does the PR have a complete description? Does it explain what the PR is attempting to do/fix, does it explain how it does this? \n - - [ ] Is there an explanation of why this PR is needed? \n - - [ ] Please use the following PR template: https://github.com/tardis-sn/tardis/blob/master/.github/PULL_REQUEST_TEMPLATE.md \n + \t - [ ] Does the PR have a complete description? Does it explain what the PR is attempting to do/fix, does it explain how it does this? \n + \t - [ ] Is there an explanation of why this PR is needed? \n + \t - [ ] Please use the following PR template: https://github.com/tardis-sn/tardis/blob/master/.github/PULL_REQUEST_TEMPLATE.md \n - [ ] Is this a duplicate PR? \n - - [ ] If a new PR is clearly a duplicate, ask how this PR is different from the original PR? \n - - [ ] If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue. \n + \t - [ ] If a new PR is clearly a duplicate, ask how this PR is different from the original PR? \n + \t - [ ] If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue. \n - [ ] Does it pass existing tests and are new tests provided if required? \n - - [ ] The test coverage should not decrease, and for new features should be at or very close to 100%. \n + \t - [ ] The test coverage should not decrease, and for new features should be at or very close to 100%. \n - [ ] Is the code properly documented? \n - - [ ] If this modifies existing code, then the docs should be updated. If this adds a new feature, additional documentation should be created. \n - - [ ] Sphinx and docstrings in the code (in numpydoc format) \n + \t - [ ] If this modifies existing code, then the docs should be updated. If this adds a new feature, additional documentation should be created. \n + \t - [ ] Sphinx and docstrings in the code (in numpydoc format) \n - [ ] Does this conform to PEP 8 and the TARDIS style guidelines? \n - [ ] Does the PR fix the problem it describes? \n - - [ ] Make sure it doesn’t e.g. just fix the problem for a specific case \n - - [ ] Is this the best way of fixing the problem? \n + \t - [ ] Make sure it doesn’t e.g. just fix the problem for a specific case \n + \t - [ ] Is this the best way of fixing the problem? \n - [ ] Is the code tidy? \n - - [ ] No unnecessary print lines or code comments \n" + \t - [ ] No unnecessary print lines or code comments \n" check_for_duplicate_msg: true # this is only commented once From 3bc40a3e9ccefc8fc325d93257b92fe855d3368a Mon Sep 17 00:00:00 2001 From: Arjun Savel <35353555+arjunsavel@users.noreply.github.com> Date: Wed, 8 Jul 2020 11:43:35 -0700 Subject: [PATCH 4/4] Update comment_PR.yml --- .github/workflows/comment_PR.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/comment_PR.yml b/.github/workflows/comment_PR.yml index eabf8a3..236a54a 100644 --- a/.github/workflows/comment_PR.yml +++ b/.github/workflows/comment_PR.yml @@ -14,7 +14,7 @@ jobs: - [ ] Is the necessary information provided? \n \t - [ ] Does the PR have a complete description? Does it explain what the PR is attempting to do/fix, does it explain how it does this? \n \t - [ ] Is there an explanation of why this PR is needed? \n - \t - [ ] Please use the following PR template: https://github.com/tardis-sn/tardis/blob/master/.github/PULL_REQUEST_TEMPLATE.md \n + \t - [ ] Please use the [TARDIS PR template](https://github.com/tardis-sn/tardis/blob/master/.github/PULL_REQUEST_TEMPLATE.md) \n - [ ] Is this a duplicate PR? \n \t - [ ] If a new PR is clearly a duplicate, ask how this PR is different from the original PR? \n \t - [ ] If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue. \n