Просмотр исходного кода

Merge pull request #197 from atsju/JST_issueTemplate

Add issue templates
Hish15 4 лет назад
Родитель
Сommit
898297d8d7
2 измененных файлов с 57 добавлено и 0 удалено
  1. 37 0
      .github/ISSUE_TEMPLATE/bug-report.md
  2. 20 0
      .github/ISSUE_TEMPLATE/feature_request.md

+ 37 - 0
.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Sources to reproduce**
+Please provide link to repository showing the problem.
+ - Fork this repository
+ - Modify an existing example to show the abnormal behavior
+ - Share the link to the commit in your fork showing the problem
+
+**Steps to reproduce**
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Compiler: [e.g. arm-none-eabi-gcc +version]
+ - stm32-cmake: [v2.0 or 86d1dd2 or ...]
+
+**Additional context**
+Add any other context about the problem here.

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

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