Skip to content

Commit

Permalink
docs(.github): create ISSUE_TEMPLATE (#521)
Browse files Browse the repository at this point in the history
  • Loading branch information
levithomason authored Sep 21, 2016
1 parent 49f07e1 commit 5aa4614
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -531,7 +531,7 @@ Adding documentation for new components is a bit tedious. The best way to do th
[5]: http://semantic-ui.com/elements/header
[6]: http://semantic-ui.com/views/item
[7]: https://github.com/TechnologyAdvice/stardust/pull/281#issuecomment-228663527
[8]: https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit
[8]: https://github.com/angular/angular.js/blob/master/.github/CONTRIBUTING.md#commit
[9]: http://semantic-ui.com/introduction/glossary.html
[10]: http://semantic-ui.com/elements/label.html
[11]: https://nodejs.org/
Expand Down
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<!--=======================================================
Thanks for submitting!
Use the appropriate template below, remove the other.
========================================================-->

<!--------------------------------------
BUG TEMPLATE
--------------------------------------->
## Steps to Reproduce

## Expected Behavior

## Actual Behavior

## Version

Stardust: `x.y.z`
Browser:
OS:

## Test Case

Fork: http://codepen.io/levithomason/pen/ZpBaJX

<!--------------------------------------
FEATURE REQUEST TEMPLATE
--------------------------------------->
## Description

I'd like...

This is needed because...

## Example Code

## Example Result

## Prototype (optional)

Fork: http://codepen.io/levithomason/pen/ZpBaJX
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ npm run release:patch

Made with :heart: [@TechnologyAdvice][9], a ridiculous [place to work][16].

[1]: https://github.com/TechnologyAdvice/stardust/blob/master/CONTRIBUTING.md
[1]: https://github.com/TechnologyAdvice/stardust/blob/master/.github/CONTRIBUTING.md
[2]: https://technologyadvice.github.io/stardust/
[3]: https://facebook.github.io/react/
[4]: https://github.com/TechnologyAdvice/stardust/labels/help%20wanted
Expand Down
2 changes: 1 addition & 1 deletion docs/app/Components/ComponentDoc/ComponentDoc.js
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ export default class ComponentDoc extends Component {
{docgen.docBlock.description || (
<span>
<a href={getGithubEditUrl(_meta.name)}>Add a description</a>. Instructions are{' '}
<a href={'https://github.com/TechnologyAdvice/stardust/blob/master/CONTRIBUTING.md#components'}>
<a href={'https://github.com/TechnologyAdvice/stardust/blob/master/.github/CONTRIBUTING.md#components'}>
here.
</a>
{' '}Description is in the SUI Docs, right there <Icon name='pointing right' />
Expand Down
6 changes: 4 additions & 2 deletions docs/app/Components/ComponentDoc/ComponentExamples.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,10 @@ export default class ComponentExamples extends Component {
<Message.Content>
If there's no
<a href='https://github.com/TechnologyAdvice/stardust/pulls'> pull request </a>
open for <code>{`<${name} />`}</code> examples, you should
<a href='https://github.com/TechnologyAdvice/stardust/blob/master/CONTRIBUTING.md'> contribute</a>!
open for <code>{`<${name} />`}</code> examples, you should{' '}
<a href='https://github.com/TechnologyAdvice/stardust/blob/master/.github/CONTRIBUTING.md'>
contribute
</a>!
</Message.Content>
</Message>
</Grid.Column>
Expand Down

0 comments on commit 5aa4614

Please sign in to comment.