浏览代码

Update issue templates

Alex Sosnovskiy 5 年之前
父节点
当前提交
8e4ff5478a
共有 2 个文件被更改,包括 56 次插入0 次删除
  1. 28 0
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 28 0
      .github/ISSUE_TEMPLATE/peer-template.md

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

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### I'm having an issue:
+  - Give an expressive description of what is went wrong
+  - Version of `peer` you're experiencing this issue
+  - Nodejs version?
+  - Platform name and its version (Win, Mac, Linux)?
+  - Nice to have: a repository with code to reproduce the issue
+  - If you're getting an error or exception, please provide its full stack-trace as plain-text or screenshot
+
+### I have a suggestion:
+  - Describe your feature / request
+  - How you're going to use it? Give a usage example(s)
+
+### Documentation is missing something or incorrect (have typos, etc.):
+  - Give an expressive description what you have changed/added and why
+  - Make sure you're using correct markdown markup
+  - Make sure all code blocks starts with triple ``` (*backtick*) and have a syntax tag, for more read [this docs](https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting)
+  - Post addition/changes in issue, we will manage it
+
+## Thank you, and do not forget to get rid of this default message

+ 28 - 0
.github/ISSUE_TEMPLATE/peer-template.md

@@ -0,0 +1,28 @@
+---
+name: peer template
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### I'm having an issue:
+  - Give an expressive description of what is went wrong
+  - Version of `peer` you're experiencing this issue
+  - Nodejs version?
+  - Platform name and its version (Win, Mac, Linux)?
+  - Nice to have: a repository with code to reproduce the issue
+  - If you're getting an error or exception, please provide its full stack-trace as plain-text or screenshot
+
+### I have a suggestion:
+  - Describe your feature / request
+  - How you're going to use it? Give a usage example(s)
+
+### Documentation is missing something or incorrect (have typos, etc.):
+  - Give an expressive description what you have changed/added and why
+  - Make sure you're using correct markdown markup
+  - Make sure all code blocks starts with triple ``` (*backtick*) and have a syntax tag, for more read [this docs](https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting)
+  - Post addition/changes in issue, we will manage it
+
+## Thank you, and do not forget to get rid of this default message