aboutsummaryrefslogtreecommitdiff
path: root/.github/pull_request_template.md
diff options
context:
space:
mode:
Diffstat (limited to '.github/pull_request_template.md')
-rw-r--r--.github/pull_request_template.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 9578777c..a1c3e74a 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,23 +1,23 @@
-# Pull Request
-
-## Note: IF YOUR PR CHANGES THE GAME BEHAVIOR VISIBLY, REMEMBER TO ATTACH A GAMEPLAY FOOTAGE (or at least a screenshot) OF YOU *ACTUALLY* PLAYING THE GAME WITH YOUR CHANGES. Untested PRs are *NOT* welcome. Please don't forget to describe what did you do in each commit in your PR.
+<!--
+Note: IF YOUR PR CHANGES THE GAME BEHAVIOR VISIBLY, REMEMBER TO ATTACH A GAMEPLAY FOOTAGE (or at least a screenshot) OF YOU *ACTUALLY* PLAYING THE GAME WITH YOUR CHANGES. Untested PRs are *NOT* welcome. Please don't forget to describe what did you do in each commit in your PR.
+-->
## Description
-Briefly describe the changes this PR introduces.
+<!-- Briefly describe the changes this PR introduces. -->
## Changes
### Previous Behavior
-*Describe how the code behaved before this change.*
+<!-- Describe how the code behaved before this change. -->
### Root Cause
-*Explain the core reason behind the erroneous/old behavior (e.g., bug, design flaw, missing edge case).*
+<!-- Explain the core reason behind the erroneous/old behavior (e.g., bug, design flaw, missing edge case). -->
### New Behavior
-*Describe how the code behaves after this change.*
+<!-- Describe how the code behaves after this change. -->
### Fix Implementation
-*Detail exactly how the issue was resolved (specific code changes, algorithms, logic flows).*
+<!-- Detail exactly how the issue was resolved (specific code changes, algorithms, logic flows). -->
## Related Issues
- Fixes #[issue-number]