Skip to content

Commit

Permalink
chore(template): update ISSUE_TEMPLATE.md and CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
atlwendy authored and benjamincharity committed Apr 3, 2019
1 parent f32aa4b commit bf37393
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 10 deletions.
33 changes: 27 additions & 6 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,30 @@
<!--
### When reporting an issue, please fill out these questions and follow the steps.

When reporting an issue:
#### 1. What is the expected behavior?

1. Provide a reproduction along with the neccessary steps outlined.
2. Include screenshots or gifs if helpful when explaining an issue.
3. DEFINE WHAT VERSION OF THE LIBRARY IS AFFECTED.

-->
#### 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?
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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?
Expand Down Expand Up @@ -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

0 comments on commit bf37393

Please sign in to comment.