From 8aec53b331f1c1876c4fd11f345e8d2000a47eeb Mon Sep 17 00:00:00 2001 From: Yashu Mittal Date: Thu, 19 Jul 2018 07:04:53 +0530 Subject: [PATCH] docs: Update issue templates * Create icon_request.md * Delete ISSUE_TEMPLATE.md * Create bug_report.md * creating an example bug report * Using same bug report from issue template --- .github/ISSUE_TEMPLATE.md | 10 ---- .github/ISSUE_TEMPLATE/bug_report.md | 67 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/icon_request.md | 14 ++++++ CONTRIBUTING.md | 22 +++++++-- 4 files changed, 98 insertions(+), 15 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/icon_request.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 756fe42..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,10 +0,0 @@ - - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..555215b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,67 @@ +--- +name: Bug report +about: Create a report to help us improve +--- + + + +## Prerequisites + +* Version: +* Are you running from source/master: +* Are you using a released build: +* Operating system: +* Bits: + +## Step to reproduce + +*(Type here)* + +### Actual behavior + +## Any message or error + +*(Type here)* + +## Resources + +* Links +* Screenshots + + +Here is what a great bug report would look like: + +``` +## Prerequisites + +Version: Release v3.1.0 +Running from: Import using webpack +Operating system: Mac OSX +Bits: 64 bits + +## Step to reproduce + + - Import `check` icon + - Add to a React component/view + - Run the react app + - Notice that the `check` isn't rendering correctly which seems a encoding problem + +### Actual behavior: + + - Import `check` icon + - Add to a React component/view + - Run the react app + - Check is displayed with correct encoding (e.g UTF-8) + +## Any message or error + +No console output +... + +## Resources + +No resources +... +``` diff --git a/.github/ISSUE_TEMPLATE/icon_request.md b/.github/ISSUE_TEMPLATE/icon_request.md new file mode 100644 index 0000000..3648775 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/icon_request.md @@ -0,0 +1,14 @@ +--- +name: Icon request +about: Suggest an new icon for this project +--- + + + +## Icon Request + +* Icon name: +* Use case: +* Screenshots of similar icons: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee9cacc..880b81a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,24 +37,36 @@ When creating a new issue make sure to include the following: - A screenshot of any visual bug. Here is what a great bug report would look like: + ``` -Check not rendering properly +## Prerequisites Version: Release v3.1.0 -Downloaded from: Import using webpack -OS: Mac OSX +Running from: Import using webpack +Operating system: Mac OSX +Bits: 64 bits + +## Step to reproduce -How to reproduce: - Import `check` icon - Add to a React component/view - Run the react app - Notice that the `check` isn't rendering correctly which seems a encoding problem -Actual result: + +### Actual behavior: + - Import `check` icon - Add to a React component/view - Run the react app - Check is displayed with correct encoding (e.g UTF-8) +## Any message or error + No console output ... + +## Resources + +No resources +... ```