From bf3739382f0b1ce5b9e818e159f43e9db33ba429 Mon Sep 17 00:00:00 2001 From: Wendy Yang Date: Mon, 1 Apr 2019 11:18:22 -0400 Subject: [PATCH] chore(template): update ISSUE_TEMPLATE.md and CONTRIBUTING.md --- .github/ISSUE_TEMPLATE.md | 33 +++++++++++++++++++++++++++------ CONTRIBUTING.md | 7 +++---- 2 files changed, 30 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 157c569ac..6cc6144a2 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,9 +1,30 @@ - +#### 2. What is the current behavior? + + +#### 3. What are the steps to reproduce? + +Providing a reproduction is the *best* way to share your issue. + +a) Fork our starter repo: https://github.com/GetTerminus/ui-stackblitz-starter + +b) Replicate your issue. + +c) Add a link to your replication or attach a zip of your project to this issue. + +d) Outline any steps needed to reproduce the issue. + + +#### 4. Which versions of this library, Angular, TypeScript, & browsers are affected? + +- UI Library: +- Angular: +- TypeScript: +- Browser(s): + + +#### 5. Is there anything else we should know? diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 391503bb4..15f069148 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,8 +33,7 @@ Help us keep Terminus open and inclusive. Please read and follow our [Code of Co If you find a bug in the source code or a mistake in the documentation, you can help us by [submitting an issue](#submit-issue) to our [GitHub repository][github]. Including an issue -reproduction (via our [demo site][demo]) is the absolute best way to help the team quickly -diagnose the problem. Screenshots are also helpful. +-reproduction (via our [starter app][starter-app]) is the absolute best way to help the team quickly diagnose the problem. Screenshots are also helpful. You can help the team even more and [submit a Pull Request](#submit-pr) with a fix! :pray: @@ -66,8 +65,7 @@ chances of your issue being dealt with quickly: - **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you - **Browsers and Operating System** - is this a problem with all browsers? -- **Reproduce the Error** - provide a live example using our [Demo site][demo] or a - unambiguous set of steps +- **Reproduce the Error** - Please fork our [starter app][starter-app] to replicate your issue and then share that link. - **Screenshots** - Due to the visual nature of this library, screenshots can help the team triage issues far more quickly than a text description. - **Related Issues** - has a similar issue been reported before? @@ -140,3 +138,4 @@ To ensure consistency throughout the source code, keep these rules in mind as yo [pulls]: https://github.com/GetTerminus/terminus-ui/pulls [dev-docs]: https://github.com/GetTerminus/terminus-ui/blob/master/DEVELOPMENT.md [commit]: https://github.com/GetTerminus/terminus-ui/blob/master/DEVELOPMENT.md#committing +[starter-app]: https://github.com/GetTerminus/ui-stackblitz-starter