From 34861cc7ec685f1a4cf2575027b26f745bdc5f8b Mon Sep 17 00:00:00 2001 From: Wes Bonelli Date: Fri, 4 Aug 2023 08:55:32 -0400 Subject: [PATCH 1/3] docs: add PR template, add compiler version to bug report template --- .github/ISSUE_TEMPLATE/bug_report.md | 9 +++++---- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 7 +++++++ 2 files changed, 12 insertions(+), 4 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index bbfd8d081ab..6d7a3d18f05 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,7 +10,7 @@ assignees: '' **Describe the bug** A clear and concise description of what the bug is. -**To Reproduce** +**To reproduce** Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' @@ -23,6 +23,7 @@ A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. -**Desktop (please complete the following information):** - - OS: [e.g. macOS, Linux, Windows] - - Version [e.g. 22] +**Environment** + - Operating system (e.g. macOS, Linux, Windows) and version + - MODFLOW 6 version (if installed via distribution) + - Compiler toolchain/version (if built from source) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 00000000000..71b85784dd4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,7 @@ +Feel free to remove check-list items that aren't relevant to your change. + +- [ ] Closes #xxxx +- [ ] Passed autotests +- [ ] Formatted source files +- [ ] Updated makefiles if new source files added +- [ ] Described new features or behavior changes in release notes \ No newline at end of file From 7538f334bf444e13dc065bce70c75298c165c285 Mon Sep 17 00:00:00 2001 From: Wes Bonelli Date: Mon, 7 Aug 2023 11:30:47 -0400 Subject: [PATCH 2/3] revisions --- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 71b85784dd4..a0ac6cf249b 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -2,6 +2,7 @@ Feel free to remove check-list items that aren't relevant to your change. - [ ] Closes #xxxx - [ ] Passed autotests -- [ ] Formatted source files +- [ ] Formatted source files using `fprettify` - [ ] Updated makefiles if new source files added -- [ ] Described new features or behavior changes in release notes \ No newline at end of file +- [ ] Updated definition (*.dfn) files with new or modified options +- [ ] Described new options, features or behavior changes in release notes \ No newline at end of file From f12515b7655b59b16d8b4dba1e7e652f6762e41c Mon Sep 17 00:00:00 2001 From: Wes Bonelli Date: Mon, 7 Aug 2023 12:05:41 -0400 Subject: [PATCH 3/3] rephrase PR checklist item to include meson, make and msvs files --- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index a0ac6cf249b..1affcbe0ed5 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -2,7 +2,7 @@ Feel free to remove check-list items that aren't relevant to your change. - [ ] Closes #xxxx - [ ] Passed autotests -- [ ] Formatted source files using `fprettify` -- [ ] Updated makefiles if new source files added +- [ ] Formatted source files with `fprettify` - [ ] Updated definition (*.dfn) files with new or modified options -- [ ] Described new options, features or behavior changes in release notes \ No newline at end of file +- [ ] Described new options, features or behavior changes in release notes +- [ ] Updated meson files, makefiles, and Visual Studio project files if new source files added \ No newline at end of file