From 8e4ff5478a5a9b368b5404b4a4c5a22a2eada3b8 Mon Sep 17 00:00:00 2001 From: Alex Sosnovskiy Date: Mon, 11 May 2020 21:55:11 +0300 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 28 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/peer-template.md | 28 +++++++++++++++++++++++++ 2 files changed, 56 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/peer-template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..4c6aeed --- /dev/null +++ b/.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 diff --git a/.github/ISSUE_TEMPLATE/peer-template.md b/.github/ISSUE_TEMPLATE/peer-template.md new file mode 100644 index 0000000..a380cba --- /dev/null +++ b/.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