Browse Source

Add contribution documentation

Geoffrey Horsington 5 years ago
parent
commit
1c61bfc5e9
2 changed files with 42 additions and 0 deletions
  1. 25 0
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 17 0
      .github/ISSUE_TEMPLATE/feature_request.md

+ 25 - 0
.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+A short description of what you did for the bug to happen.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots and logs**
+Include a console log, if the error is visible there.  
+If not possible, include a screenshot of the error.
+
+**Desktop (please complete the following information):**
+ - Game and game version [e.g. COM3D2 1.15]: 
+ - BepInEx version [e.g. 4.0]: 
+
+**Additional context**
+Add any other context about the problem here.

+ 17 - 0
.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**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.