Skip to content

Commit

Permalink
Add some issue_template files
Browse files Browse the repository at this point in the history
  • Loading branch information
naokazuterada committed Mar 11, 2018
1 parent b2806a3 commit 2cc9301
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 11 deletions.
13 changes: 8 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@ These are the guidelines for contributing to this repository.

## Issues

File an issue if you think you've found a bug. Please describe
Please follow the each template by the type of your issue.

1. How can it be reproduced
2. What was expected
3. What actually occurred
4. What version of the involved component
- [Bug Report](https://github.com/naokazuterada/MarkdownTOC/issues/new)
- [Feature Request](https://github.com/naokazuterada/MarkdownTOC/issues/new?template=feature.md)
- [Question](https://github.com/naokazuterada/MarkdownTOC/issues/new?template=question.md)

### Way of operation

Expand All @@ -20,6 +19,10 @@ File an issue if you think you've found a bug. Please describe
- Not obvious: Problem is not obvious, or not reproduced.
- Not responding: Author doesn't respond in 3 weeks.

## Gitter

If you want to ask more easily, please use [Gitter](https://gitter.im/naokazuterada/MarkdownTOC) chat system.

## Patches

Patches for fixes, features, and improvements are accepted via pull requests.
Expand Down
29 changes: 23 additions & 6 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
<!--
File an issue if you think you've found a bug. Please describe
1. How can it be reproduced
2. What was expected
3. What actually occurred
4. What version of the involved component
-->
Template: BUG REPORT
This is an issue for a bug report.
You should label `bug-report`.
If your purpose is different, please visit following links.
FEATURE REQUEST:
https://github.com/naokazuterada/MarkdownTOC/issues/new?template=feature.md
QUESTION:
https://github.com/naokazuterada/MarkdownTOC/issues/new?template=question.md
-->

# How can it be reproduced

# What was expected

# What actually occurred

# What version of the involved component
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
Template: FEATURE REQUEST
This is an issue for a feature request.
You should label `feature-request`.
If your purpose is different, please visit following links.
BUG REPORT:
https://github.com/naokazuterada/MarkdownTOC/issues/new?template=bug.md
QUESTION:
https://github.com/naokazuterada/MarkdownTOC/issues/new?template=question.md
-->

# Purpose

# How important it is

# Ideal implementation
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!--
Template: QUESTION
This is an issue for a feature request.
You should label `question`.
If your purpose is different, please visit following links.
BUG REPORT:
https://github.com/naokazuterada/MarkdownTOC/issues/new?template=bug.md
FEATURE REQUEST:
https://github.com/naokazuterada/MarkdownTOC/issues/new?template=feature.md
-->

# Question

0 comments on commit 2cc9301

Please sign in to comment.