From 59ef07b2bf09e24b89b6ddedd26c445f155c6148 Mon Sep 17 00:00:00 2001 From: "Balos, Cody, J" Date: Wed, 15 May 2024 09:59:57 -0700 Subject: [PATCH 1/8] add PR template --- .github/PULL_REQUEST_TEMPLATE/general.md | 9 +++++++++ .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 0 2 files changed, 9 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/general.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/general.md b/.github/PULL_REQUEST_TEMPLATE/general.md new file mode 100644 index 0000000000..3c0fe95139 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/general.md @@ -0,0 +1,9 @@ + +Thank you for your interest in contributing to SUNDIALS. A pull request to SUNDIALS requires the following steps to be completed + +- [ ] Please target the `develop` branch not `main`. +- [ ] Review our [Contributing Guide](https://github.com/LLNL/sundials/blob/main/CONTRIBUTING.md), and ensure that you sign your last commit (at minimum) as per the guide. +- [ ] Provide a concise description of what your pull request does, and why it is needed/benefical. +- [ ] Add a note about your change to the `CHANGELOG.md` and `docs/shared/RecentChanges.rst`. Notice that the former is a markdown file and the latter is reStructuredText, so the formatting is slightly different. +- [ ] Ensure that all of the tests are passing (a SUNDIALS developer will have to allow the testing to run). + diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md deleted file mode 100644 index e69de29bb2..0000000000 From cdd68e888709833de2d75b0c035ea9c166ffe87d Mon Sep 17 00:00:00 2001 From: "Balos, Cody, J" Date: Wed, 15 May 2024 10:04:19 -0700 Subject: [PATCH 2/8] add issue templates --- .github/ISSUE_TEMPLATE/bug.md | 40 +++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/general.md | 8 +++++++ 2 files changed, 48 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/general.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000000..367e3512d0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,40 @@ +--- +name: 🐞 Bug +about: File a bug/issue +title: '[BUG] ' +labels: bug, triage +assignees: '' + +--- + +<!-- +Note: Please search to see if an issue already exists for the bug you encountered. +--> + +### Current Behavior: +<!-- A concise description of what you're experiencing. --> + +### Expected Behavior: +<!-- A concise description of what you expected to happen. --> + +### Steps To Reproduce: +<!-- +Example: steps to reproduce the behavior: +1. In this environment... +1. With this config... +1. Run '...' +1. See error... +--> + +### Environment: +<!-- +Example: +- SUNDIALS version: 7.0.0 +- OS: Ubuntu 20.04 +- Compiler: gcc 8.5.0 +--> + +### Anything else: +<!-- +Links? References? Anything that will give us more context about the issue that you are encountering! +--> diff --git a/.github/ISSUE_TEMPLATE/general.md b/.github/ISSUE_TEMPLATE/general.md new file mode 100644 index 0000000000..212e035190 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general.md @@ -0,0 +1,8 @@ +--- +name: General/Question +about: File a issue for something that is not a bug +title: '<title>' +labels: triage +assignees: '' + +--- \ No newline at end of file From 4ff9059982ebb2ab3185af9e215f1d289ab45f96 Mon Sep 17 00:00:00 2001 From: "Balos, Cody, J" <balos1@llnl.gov> Date: Wed, 15 May 2024 10:11:02 -0700 Subject: [PATCH 3/8] clarify testing point template --- .github/PULL_REQUEST_TEMPLATE/general.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/general.md b/.github/PULL_REQUEST_TEMPLATE/general.md index 3c0fe95139..604162d212 100644 --- a/.github/PULL_REQUEST_TEMPLATE/general.md +++ b/.github/PULL_REQUEST_TEMPLATE/general.md @@ -1,9 +1,9 @@ -Thank you for your interest in contributing to SUNDIALS. A pull request to SUNDIALS requires the following steps to be completed +<!-- Thank you for your interest in contributing to SUNDIALS. A pull request to SUNDIALS requires the following steps to be completed --> - [ ] Please target the `develop` branch not `main`. - [ ] Review our [Contributing Guide](https://github.com/LLNL/sundials/blob/main/CONTRIBUTING.md), and ensure that you sign your last commit (at minimum) as per the guide. - [ ] Provide a concise description of what your pull request does, and why it is needed/benefical. - [ ] Add a note about your change to the `CHANGELOG.md` and `docs/shared/RecentChanges.rst`. Notice that the former is a markdown file and the latter is reStructuredText, so the formatting is slightly different. -- [ ] Ensure that all of the tests are passing (a SUNDIALS developer will have to allow the testing to run). +- [ ] After your PR is opened, ensure that all of the tests are passing (a SUNDIALS developer will have to allow the testing to run). From 7a4658cce269f1e0134e2221ee9b28dbecb118ff Mon Sep 17 00:00:00 2001 From: "Balos, Cody, J" <balos1@llnl.gov> Date: Wed, 15 May 2024 10:19:51 -0700 Subject: [PATCH 4/8] move default PR template to spot where GitHub expects --- .github/ISSUE_TEMPLATE/bug.md | 2 +- .../general.md => PULL_REQUEST_TEMPLATE.md} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename .github/{PULL_REQUEST_TEMPLATE/general.md => PULL_REQUEST_TEMPLATE.md} (100%) diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 367e3512d0..28901c4b88 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -1,6 +1,6 @@ --- name: 🐞 Bug -about: File a bug/issue +about: File a bug report title: '[BUG] <title>' labels: bug, triage assignees: '' diff --git a/.github/PULL_REQUEST_TEMPLATE/general.md b/.github/PULL_REQUEST_TEMPLATE.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE/general.md rename to .github/PULL_REQUEST_TEMPLATE.md From 7a1a83f8f044cc9d4f6150f278c2289c2c876398 Mon Sep 17 00:00:00 2001 From: Cody Balos <balos1@llnl.gov> Date: Wed, 15 May 2024 10:20:23 -0700 Subject: [PATCH 5/8] Apply suggestions from code review Co-authored-by: Daniel R. Reynolds <reynolds@smu.edu> --- .github/ISSUE_TEMPLATE/general.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/general.md b/.github/ISSUE_TEMPLATE/general.md index 212e035190..2d8ea7ab65 100644 --- a/.github/ISSUE_TEMPLATE/general.md +++ b/.github/ISSUE_TEMPLATE/general.md @@ -1,6 +1,6 @@ --- name: General/Question -about: File a issue for something that is not a bug +about: File an issue for something that is not a bug title: '<title>' labels: triage assignees: '' From bc42c050384c8c28f0138045da8cb0cb268f7ffd Mon Sep 17 00:00:00 2001 From: "Balos, Cody, J" <balos1@llnl.gov> Date: Wed, 15 May 2024 10:20:40 -0700 Subject: [PATCH 6/8] grammar --- .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 604162d212..cac3493f9d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,6 +4,6 @@ - [ ] Please target the `develop` branch not `main`. - [ ] Review our [Contributing Guide](https://github.com/LLNL/sundials/blob/main/CONTRIBUTING.md), and ensure that you sign your last commit (at minimum) as per the guide. - [ ] Provide a concise description of what your pull request does, and why it is needed/benefical. -- [ ] Add a note about your change to the `CHANGELOG.md` and `docs/shared/RecentChanges.rst`. Notice that the former is a markdown file and the latter is reStructuredText, so the formatting is slightly different. +- [ ] Add a note about your change to the `CHANGELOG.md` and `docs/shared/RecentChanges.rst` files. Notice that the former is a markdown file and the latter is reStructuredText, so the formatting is slightly different. - [ ] After your PR is opened, ensure that all of the tests are passing (a SUNDIALS developer will have to allow the testing to run). From 77fd6fc9fb05b061f66c68d69dc5fb3deb6b5f3d Mon Sep 17 00:00:00 2001 From: "Balos, Cody, J" <balos1@llnl.gov> Date: Wed, 15 May 2024 10:23:43 -0700 Subject: [PATCH 7/8] add a note for developers --- .github/PULL_REQUEST_TEMPLATE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index cac3493f9d..4080b9fd5f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,6 @@ -<!-- Thank you for your interest in contributing to SUNDIALS. A pull request to SUNDIALS requires the following steps to be completed --> +<!-- SUNDIALS developers only: remove the checklist before opening a PR and refer to the developer's guide instructions. --> +<!-- Thank you for your interest in contributing to SUNDIALS. A pull request to SUNDIALS requires the following steps to be completed: --> - [ ] Please target the `develop` branch not `main`. - [ ] Review our [Contributing Guide](https://github.com/LLNL/sundials/blob/main/CONTRIBUTING.md), and ensure that you sign your last commit (at minimum) as per the guide. From 696336c0cba2bebb6a5aae573f97e6de185b7d41 Mon Sep 17 00:00:00 2001 From: Cody Balos <balos1@llnl.gov> Date: Wed, 15 May 2024 11:23:38 -0700 Subject: [PATCH 8/8] Update bug.md --- .github/ISSUE_TEMPLATE/bug.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 28901c4b88..1cdc3dfbcb 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -1,5 +1,5 @@ --- -name: 🐞 Bug +name: Bug about: File a bug report title: '[BUG] <title>' labels: bug, triage @@ -21,9 +21,9 @@ Note: Please search to see if an issue already exists for the bug you encountere <!-- Example: steps to reproduce the behavior: 1. In this environment... -1. With this config... -1. Run '...' -1. See error... +2. With this config... +3. Run '...' +4. See error... --> ### Environment: