Skip to content

Commit 4a08e9d

Browse files
committed
Merge branch 'update-contributing'
* update-contributing: Correct the incorrect or not natural English expressions Thank you for @jonasbn ! Add some issue_template files Update CONTRIBUTING.md WIP: Add 'Way of operation' section Add 'Useful Tools' Cleanup: Remove trailing white spaces
2 parents 97e8952 + d867a75 commit 4a08e9d

File tree

4 files changed

+86
-11
lines changed

4 files changed

+86
-11
lines changed

.github/CONTRIBUTING.md

+21-5
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,24 @@ These are the guidelines for contributing to this repository.
44

55
## Issues
66

7-
File an issue if you think you've found a bug. Please describe
7+
Please use the template for your type of issue.
88

9-
1. How can it be reproduced
10-
2. What was expected
11-
3. What actually occurred
12-
4. What version of the involved component
9+
- [Bug Report](https://github.com/naokazuterada/MarkdownTOC/issues/new)
10+
- [Feature Request](https://github.com/naokazuterada/MarkdownTOC/issues/new?template=feature.md)
11+
- [Question](https://github.com/naokazuterada/MarkdownTOC/issues/new?template=question.md)
12+
13+
### Way of operation
14+
15+
1. The maintainers will `Close` the issue or PR
16+
1. Not accepted feature request
17+
- Add the `wontfix` label
18+
2. Not clear or unresponsive
19+
- Not clear: Problem is not obvious or not reproducible.
20+
- Unresponsive: the author does not respond to inquiries within 3 weeks.
21+
22+
## Gitter
23+
24+
If you want more general support or to ask questions, please use [Gitter](https://gitter.im/naokazuterada/MarkdownTOC) chat system.
1325

1426
## Patches
1527

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

3446
All contributions are welcome
3547

48+
## Useful Tools
49+
50+
- [Gyazo](https://gyazo.com/en): Tool for making animated GIFs from screen captures. Use it for showing how the function works.
51+
3652
## Licensing and copyright
3753

3854
Please note that accepted contributions are included in the repository and hence under the same license as the repository contributed to.

.github/ISSUE_TEMPLATE.md

+23-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,25 @@
11
<!--
2-
File an issue if you think you've found a bug. Please describe
32
4-
1. How can it be reproduced
5-
2. What was expected
6-
3. What actually occurred
7-
4. What version of the involved component
8-
-->
3+
Template: BUG REPORT
4+
5+
This is an template for a bug report.
6+
You should label `bug-report`.
7+
8+
9+
If your issue is not a bug report, please visit one of the following links.
10+
11+
FEATURE REQUEST:
12+
https://github.com/naokazuterada/MarkdownTOC/issues/new?template=feature.md
13+
14+
QUESTION:
15+
https://github.com/naokazuterada/MarkdownTOC/issues/new?template=question.md
16+
17+
-->
18+
19+
# How can the issue be reproduced
20+
21+
# What was expected
22+
23+
# What actually occurred
24+
25+
# What was the version of the involved component

.github/ISSUE_TEMPLATE/feature.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!--
2+
3+
Template: FEATURE REQUEST
4+
5+
This is an template for a feature request.
6+
You should label `feature-request`.
7+
8+
9+
If your issue is not a feature request, please visit one of the following links.
10+
11+
BUG REPORT:
12+
https://github.com/naokazuterada/MarkdownTOC/issues/new?template=bug.md
13+
14+
QUESTION:
15+
https://github.com/naokazuterada/MarkdownTOC/issues/new?template=question.md
16+
17+
-->
18+
19+
# Purpose
20+
21+
# How important it is
22+
23+
# Ideal implementation

.github/ISSUE_TEMPLATE/question.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!--
2+
3+
Template: QUESTION
4+
5+
This is a template for a general question
6+
You should label `question`.
7+
8+
9+
If your issue is not a question, please visit one of the following links.
10+
11+
BUG REPORT:
12+
https://github.com/naokazuterada/MarkdownTOC/issues/new?template=bug.md
13+
14+
FEATURE REQUEST:
15+
https://github.com/naokazuterada/MarkdownTOC/issues/new?template=feature.md
16+
17+
-->
18+
19+
# Question

0 commit comments

Comments
 (0)