Skip to content

Commit 737db4d

Browse files
antfuantfu
committed
docs: add issue and PR template
1 parent 45470f2 commit 737db4d

File tree

6 files changed

+141
-10
lines changed

6 files changed

+141
-10
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: 🐞 Bug report
2+
description: Report an issue
3+
labels: [pending triage]
4+
title: Describe the bug here
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
- type: checkboxes
11+
id: checkboxes
12+
attributes:
13+
label: Validations
14+
description: Before submitting the issue, please make sure you do the following
15+
options:
16+
- label: Follow our [Code of Conduct](https://github.com/shikijs/shiki/blob/main/CODE_OF_CONDUCT.md)
17+
required: true
18+
- label: Read the [Contributing Guide](https://github.com/shikijs/shiki/blob/main/CONTRIBUTING.md).
19+
required: true
20+
- label: Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
21+
required: true
22+
- type: textarea
23+
id: bug-description
24+
attributes:
25+
label: Describe the bug
26+
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
27+
placeholder: Bug description
28+
validations:
29+
required: true
30+
- type: input
31+
id: reproduction
32+
attributes:
33+
label: Reproduction
34+
description: |
35+
A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is **required**, otherwise the issue might be closed without further notice. [**Why?**](https://antfu.me/posts/why-reproductions-are-required)
36+
placeholder: Reproduction
37+
validations:
38+
required: true
39+
- type: checkboxes
40+
id: contributes
41+
attributes:
42+
label: Contributes
43+
options:
44+
- label: I am willing to submit a PR to fix this issue
45+
- label: I am willing to submit a PR with failing tests

‎.github/ISSUE_TEMPLATE/config.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
contact_links:
2+
- name: 🙌 Contribution Guide
3+
url: https://github.com/shikijs/shiki/blob/main/CONTRIBUTING.md
4+
about: Please read through before making contributions.
5+
- name: 🧑‍💻 Contribute to New Grammar
6+
url: https://github.com/shikijs/textmate-grammars-themes/#add-a-new-grammar
7+
about: Shiki uses grammars collected by `tm-grammars`. Contribute there will inherit to Shiki.
8+
- name: 🌈 Contribute to New Theme
9+
url: https://github.com/shikijs/textmate-grammars-themes/#add-a-new-grammar
10+
about: Shiki uses themes collected by `tm-themes`. Contribute there will inherit to Shiki.
11+
- name: ⁉️ Why and How to make a reproduction?
12+
url: https://antfu.me/posts/why-reproductions-are-required
13+
about: Reproduction is very important for maintainer to help on your issues!

‎.github/ISSUE_TEMPLATE/feature_request.yml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: 🚀 New feature proposal
2+
description: Propose a new feature
3+
labels: [enhancement]
4+
title: '`rule-name`: describe the feature here'
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for your interest in the project and taking the time to fill out this feature report!
10+
- type: textarea
11+
id: feature-description
12+
attributes:
13+
label: Clear and concise description of the problem
14+
description: 'I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!'
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: suggested-solution
19+
attributes:
20+
label: Suggested solution
21+
description: 'In rule [xy] we could provide following implementation...'
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: alternative
26+
attributes:
27+
label: Alternative
28+
description: Clear and concise description of any alternative solutions or features you've considered.
29+
- type: textarea
30+
id: additional-context
31+
attributes:
32+
label: Additional context
33+
description: Any other context or screenshots about the feature request here.
34+
- type: checkboxes
35+
id: checkboxes
36+
attributes:
37+
label: Validations
38+
description: Before submitting the issue, please make sure you do the following
39+
options:
40+
- label: Follow our [Code of Conduct](https://github.com/eslint-stylistic/eslint-stylistic/blob/main/CODE_OF_CONDUCT.md)
41+
required: true
42+
- label: Read the [Contributing Guide](https://eslint.style/contribute/guide).
43+
required: true
44+
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
45+
required: true
46+
- type: checkboxes
47+
id: contributes
48+
attributes:
49+
label: Contributes
50+
description: As stylistic rules can be sometime subjective or niche, we may not have enough to maintainability to fix or improve every aspect. In general, **we encourage the original reporter (or anyone wants to work on it) to submit a PR to fix issue**. Check the following if you are willing to
51+
options:
52+
- label: If this feature request is accepted, I am willing to submit a PR to fix this issue

‎.github/ISSUE_TEMPLATE/typo.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: 👀 Typo / Grammar fix
2+
description: You can just go ahead and send a PR! Thank you!
3+
labels: []
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## PR Welcome!
9+
10+
If the typo / grammar issue is trivial and straightforward, you can help by **directly sending a quick pull request**!
11+
If you spot multiple of them, we suggest combining them into a single PR. Thanks!
12+
- type: textarea
13+
id: context
14+
attributes:
15+
label: Additional context

‎.github/pull_request_template.md

+16-10
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
1-
- [ ] Add a test if possible
2-
- [ ] Format all commit messages with [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
1+
<!-- DO NOT IGNORE THE TEMPLATE!
32
4-
<!-- If fixing a bug -->
3+
Thank you for contributing!
54
6-
- [ ] This PR fixes #
5+
Before submitting the PR, please make sure you do the following:
76
8-
<!-- If adding a theme -->
7+
- Read the [Contributing Guide](https://github.com/shikijs/shiki/blob/main/CONTRIBUTING.md).
8+
- Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
9+
- Provide a description in this PR that addresses **what** the PR is solving, or reference the issue that it solves (e.g. `fixes #123`).
10+
- Ideally, include relevant tests that fail without this PR but pass with it.
911
10-
- [ ] I have read docs for [adding a theme](https://github.com/shikijs/shiki/blob/main/docs/themes.md#adding-theme).
12+
-->
1113

12-
<!-- If adding a language -->
14+
### Description
1315

14-
- [ ] I have read docs for [adding a language](https://github.com/shikijs/shiki/blob/main/docs/languages.md#adding-grammar).
15-
- [ ] I have searched around and this is the most up-to-date, actively maintained version of the language grammar.
16-
- [ ] I have added a sample file that includes a variety of language syntaxes and succinctly captures the idiosyncrasy of a language. See [docs](https://github.com/shikijs/shiki/blob/main/docs/languages.md#adding-grammar) for requirement.
16+
<!-- Please insert your description here and provide especially info about the "what" this PR is solving -->
17+
18+
### Linked Issues
19+
20+
### Additional context
21+
22+
<!-- e.g. is there anything you'd like reviewers to focus on? -->

‎.github/CONTRIBUTING.md ‎CONTRIBUTING.md

File renamed without changes.

0 commit comments

Comments
 (0)