From a746ac1f15b5ddbd8c00588bf6d2725b66bc2751 Mon Sep 17 00:00:00 2001 From: Lucas Sawade Date: Thu, 13 Feb 2025 14:07:47 -0500 Subject: [PATCH 1/3] Updated the template --- .github/ISSUE_TEMPLATE/bug_report.md | 26 +++++++++++++++-------- .github/ISSUE_TEMPLATE/feature_request.md | 11 +++++++--- .github/pull_request_template.md | 8 ++++--- 3 files changed, 30 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 5ba051351..e2c89fb95 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,28 +4,36 @@ about: Create a report to help us improve title: '' labels: '' assignees: '' - --- -**Describe the bug** -A clear and concise description of what the bug is. +# Bug Title + +A quick summary of the bug. -**To Reproduce** +## Setup information: - Installation instructions: ``` - Please paste the cmake configuration command here +Please paste the cmake configuration command here ``` -**Expected behavior** +## Expected behavior A clear and concise description of what you expected to happen. -**Screenshots** +## Actual (buggy) behavior +A clear and concise description of what is happening instead. + +## Screenshots + If applicable, add screenshots to help explain your problem. -**Machine information (please complete the following information):** +## Machine information: + +[please complete the following information:] + - OS: [e.g. Redhat] - GPU available: [e.g. Yes (NVIDIA A100)] -**Additional context** +## Additional context + Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 2dd5f501c..9e8b8261b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,11 +7,16 @@ assignees: '' --- -**Is your feature request related to a problem? Please describe.** +## Is your feature request related to a problem? A clear and concise description of what the problem is. -**Describe the solution you'd like** +## Describe the solution you'd like + A clear and concise description of what you want to happen. -**Additional context** +## Additional context + Add any other context or screenshots about the feature request here. + +If this feature request helps with an existing issue, please link the issue here. +E.g. # diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index da5ef8048..185e80082 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,12 +1,14 @@ -# Description +# Title + +## Description Please describe the changes/features in this pull request. -# Issue Number +## Issue Number If there is an issue created for these changes, link it here -# Checklist +## Checklist Please make sure to check developer documentation on specfem docs. From b682026eba116d987ac2bd223d49ad7e20c463a9 Mon Sep 17 00:00:00 2001 From: Lucas Sawade Date: Thu, 13 Feb 2025 14:09:29 -0500 Subject: [PATCH 2/3] Updated the template --- .github/ISSUE_TEMPLATE/bug_report.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e2c89fb95..9ae5ecc9c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,17 +6,6 @@ labels: '' assignees: '' --- -# Bug Title - -A quick summary of the bug. - -## Setup information: - -- Installation instructions: -``` -Please paste the cmake configuration command here -``` - ## Expected behavior A clear and concise description of what you expected to happen. @@ -27,6 +16,13 @@ A clear and concise description of what is happening instead. If applicable, add screenshots to help explain your problem. +## Setup information: + +- Installation instructions: +``` +Please paste the cmake configuration command here +``` + ## Machine information: [please complete the following information:] From 1ca5a7c0592cf2e5baa7420076021c7c2f818d42 Mon Sep 17 00:00:00 2001 From: Lucas Sawade Date: Thu, 13 Feb 2025 14:19:16 -0500 Subject: [PATCH 3/3] Updated the template --- .github/pull_request_template.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 185e80082..e3a56f3d4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,3 @@ -# Title - ## Description Please describe the changes/features in this pull request.