From a67f58915e110e21f7a9135542768405f73630ab Mon Sep 17 00:00:00 2001 From: Frank Malatino Date: Wed, 6 Mar 2024 11:39:23 -0500 Subject: [PATCH] Adding issue and PR templates --- .github/ISSUE_TEMPLATE/bug_report.md | 30 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 19 ++++++++++++++ .github/ISSUE_TEMPLATE/support_request.md | 14 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 21 ++++++++++++++++ 4 files changed, 84 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/support_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..53603ebe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: Bug Report +about: Create a bug report to help us improve +title: '' +labels: Bug +--- + +**Describe the bug** +A clear and concise description of what the bug is + +**To Reproduce** +Steps to reproduce the behavior + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**System Environment** +Describe the system environment, include: +- OS: [e.g. RHEL 7.2] +- Backend used [e.g. dace:cpu] +- Environment variables set +- Compiler(s): Type and version [e.g. Intel 19.1] +- MPI type, and version (e.g. MPICH, Cray MPI, openMPI) +- netCDF Version: For both C and Fortran +- Configure options: Any additional flags, or macros passed to configure +- If this bug came from a model run, which model + +**Additional context** +Add any other context about the problem. If applicable, include where any files +that help describe, or reproduce the problem exist. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..104f3919 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: 'enhancement' +assignees: '' +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/support_request.md b/.github/ISSUE_TEMPLATE/support_request.md new file mode 100644 index 00000000..5ce36681 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support_request.md @@ -0,0 +1,14 @@ +--- +name: Support request +about: Request for help +title: '' +labels: 'question' +assignees: '' +--- + +**Is your question related to a problem? Please describe.** +A clear and concise description of what the problem is. + +**Describe what you have tried** +A clear and concise description of what steps you have taken. Include command +lines, and any messages from the command. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..0553236c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,21 @@ +**Description** +Include a summary of the change and which issue is fixed. Please also include +relevant motivation and context. List any dependencies that are required for +this change. + +Fixes # (issue) +If this is a hotfix to a released version, please specify it. + +**How Has This Been Tested?** +Please describe the tests that you ran to verify your changes. Please also note +any relevant details for your test configuration (e.g. compiler, OS). Include +enough information so someone can reproduce your tests. + +**Checklist:** +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] Any dependent changes have been merged and published in downstream modules +- [ ] New check tests, if applicable, are included