From c3f472aceafcce254bcc884b843fe68032707c45 Mon Sep 17 00:00:00 2001 From: Rannie Peralta Date: Sun, 1 Dec 2019 16:58:28 +0800 Subject: [PATCH] Link the created CodePen bug report boilerplate --- .github/ISSUE_TEMPLATE/bug_report.md | 24 ++--------------------- .github/ISSUE_TEMPLATE/custom.md | 3 --- .github/ISSUE_TEMPLATE/feature_request.md | 2 -- CONTRIBUTING.md | 2 ++ README.md | 23 +++++++++++++--------- 5 files changed, 18 insertions(+), 36 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 5b0a804..026661d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,18 @@ --- name: Bug report about: Create a report to help us improve -title: "[BUG]" labels: bug assignees: '' - --- **Describe the bug** A clear and concise description of what the bug is. -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +**CodePen sample or screenshots** +If applicable, add a fork of [this CodePen](https://codepen.io/ranndev/pen/LYEPgmL) that describe the found bug or add screenshots to help explain your problem. **Expected behavior** A clear and concise description of what you expected to happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - **Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md index 48d5f81..96a4735 100644 --- a/.github/ISSUE_TEMPLATE/custom.md +++ b/.github/ISSUE_TEMPLATE/custom.md @@ -4,7 +4,4 @@ about: Describe this issue template's purpose here. title: '' labels: '' assignees: '' - --- - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e0c0168..6ac431d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,10 +1,8 @@ --- name: Feature request about: Suggest an idea for this project -title: "[FEATURE]" labels: '' assignees: '' - --- **Is your feature request related to a problem? Please describe.** diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8addc27..f494675 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,8 @@ Thanks for your interest in UIGuide! You are very welcome to contribute. If you find a bug, please, try to isolate the specific case and provide a fiddle on CodePen or JSFiddle to make it easy to reproduce the problem and help others finding a solution. +You can use [this CodePen](https://codepen.io/ranndev/pen/LYEPgmL) which already includes ui-guide & popper.js. + Feature requests are welcome! ## Setup diff --git a/README.md b/README.md index a11b42b..5cef6e3 100644 --- a/README.md +++ b/README.md @@ -28,14 +28,23 @@

+### Examples + +- CodePen - https://codepen.io/ranndev/pen/oNgvwQV + ### Installation -| Source | Command | -| :----- | :------------------------------------- | -| npm | `npm install @ranndev/ui-guide --save` | -| yarn | `yarn add @ranndev/ui-guide` | +```bash +# Using npm +npm install @ranndev/ui-guide --save +``` -_Note: [Popper.js](https://github.com/FezVrasta/popper.js) is a peer dependency of this package, so you must [install it](https://github.com/FezVrasta/popper.js#installation) too._ +```bash +# Using Yarn +yarn add @ranndev/ui-guide +``` + +_Note: [Popper.js](https://github.com/FezVrasta/popper.js) is a peer dependency of this package. Make sure to [install it](https://github.com/FezVrasta/popper.js#installation) too._ ### Setup @@ -50,10 +59,6 @@ There are 2 required styles that must be included into your app. If you're going to import the package using `