Skip to content
This repository has been archived by the owner on Jan 6, 2025. It is now read-only.

Commit

Permalink
Update GitHub Templates (#287)
Browse files Browse the repository at this point in the history
Description of changes

Update all GitHub templates so that template directions are comments instead of viewable text.

The hope is to improve template readability in the case that someone doesn't delete the directions when submitting an issue or PR––comments will be invisible to the reader.
  • Loading branch information
hawkticehurst authored Nov 3, 2021
1 parent f4e4481 commit 51d507a
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 13 deletions.
14 changes: 7 additions & 7 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,25 @@ assignees: hawkticehurst

### Describe the bug

_A clear and concise description of what the bug is._
<!-- A clear and concise description of what the bug is. -->

### To reproduce

_Steps to reproduce the behavior._
<!-- Steps to reproduce the behavior. -->

### Expected behavior

_A clear and concise description of what you expected to happen._
<!-- A clear and concise description of what you expected to happen. -->

### Screenshots

_If applicable, add screenshots to help explain your problem._
<!-- If applicable, add screenshots to help explain your problem. -->

### Desktop (please complete the following information):

- OS Version: _[e.g. macOS 11.3.1]_
- Toolkit Version: _[e.g. 0.5.0]_
- OS Version: [e.g. `macOS 11.3.1`]
- Toolkit Version: [e.g. `v0.8.0`]

### Additional context

_Add any other context about the problem here._
<!-- Add any other context about the problem here. -->
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ labels: enhancement

### Feature/component description

_A clear and concise description of the feature or component you're requesting._
<!-- A clear and concise description of the feature or component you're requesting. -->

### Use case

_Please provide a use case to help us understand your request in context._
<!-- Please provide a use case to help us understand your request in context. -->

### Screenshots/references

_In the case of a component request or a visually oriented feature request, providing screenshots and/or links to examples of the component/feature you're seeking will be very helpful._
<!-- In the case of a component request or a visually oriented feature request, providing screenshots and/or links to examples of the component/feature you're seeking will be very helpful. -->
8 changes: 5 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@ This pull request resolves #

### Description of changes

_Include a description of the proposed changes._
<!-- Include a description of the proposed changes. -->

### Link to forked docs site

_If component changes (especially visual changes) are contained in this PR, we ask that you provide a link to a publicly viewable version of the Storybook docs site so PR reviewers can see your changes without having to install and view your code locally._
<!--
If component changes (especially visual changes) are contained in this PR, we ask that you provide a link to a publicly viewable version of the Storybook docs site so PR reviewers can see your changes without having to install and view your code locally.
_Please see `CONTRIBUTING.md` for directions on how this can be done._
Please see `CONTRIBUTING.md` for directions on how this can be done.
-->

0 comments on commit 51d507a

Please sign in to comment.