Updated the template

PrincetonUniversity · Feb 13, 2025 · a746ac1 · a746ac1
1 parent f2b9fe1
commit a746ac1
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 15 deletions.
diff --git 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
@@ -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. #<issue number>
diff --git 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.