Skip to content

Commit

Permalink
Merge d867a75 into 97e8952
Browse files Browse the repository at this point in the history
  • Loading branch information
naokazuterada committed Mar 20, 2018
2 parents 97e8952 + d867a75 commit 04e74df
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 11 deletions.
26 changes: 21 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,24 @@ These are the guidelines for contributing to this repository.

## Issues

File an issue if you think you've found a bug. Please describe
Please use the template for your type of 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

1. The maintainers will `Close` the issue or PR
1. Not accepted feature request
- Add the `wontfix` label
2. Not clear or unresponsive
- Not clear: Problem is not obvious or not reproducible.
- Unresponsive: the author does not respond to inquiries within 3 weeks.

## Gitter

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

## Patches

Expand All @@ -33,6 +45,10 @@ You should use unit-tests for SublimeText by using [UnitTesting](https://github.

All contributions are welcome

## Useful Tools

- [Gyazo](https://gyazo.com/en): Tool for making animated GIFs from screen captures. Use it for showing how the function works.

## Licensing and copyright

Please note that accepted contributions are included in the repository and hence under the same license as the repository contributed to.
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 template for a bug report.
You should label `bug-report`.
If your issue is not a bug report, please visit one of the 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 the issue be reproduced

# What was expected

# What actually occurred

# What was the 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 template for a feature request.
You should label `feature-request`.
If your issue is not a feature request, please visit one of the 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 a template for a general question
You should label `question`.
If your issue is not a question, please visit one of the 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 04e74df

Please sign in to comment.