Skip to content

Commit def00e9

Browse files
committedSep 20, 2023
chore: update issue templates
1 parent 0b08639 commit def00e9

File tree

5 files changed

+87
-37
lines changed

5 files changed

+87
-37
lines changed
 

‎.github/ISSUE_TEMPLATE/bug_report.md

-23
This file was deleted.
+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: 🐞 Bug
2+
description: File a bug/issue
3+
title: "<title>"
4+
labels: ["bug"]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an issue already exists for the bug you encountered.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Describe the bug
16+
description: |
17+
A clear and concise description of what the bug is. Screenshots are often helpful here.
18+
19+
Do *NOT* just paste a link to other issues on GitHub.
20+
validations:
21+
required: true
22+
- type: textarea
23+
attributes:
24+
label: To Reproduce
25+
description: |
26+
1. Reproduce your issue in the [Chroma Playground](https://swapoff.org/chroma/playground/), then click the _copy_ icon to copy a shareable link for your issue. Consider using `[markdown links](URL)` to minimise the visual noise of the links.
27+
2. Provide input text and a command-line invocation of `chroma` that reproduces your problem. eg. For Hugo this might be something like `chroma -s monokailight --html --html-lines --html-lines-table --html-inline-styles <source>`
28+
29+
Do *NOT* provide configuration for another tool (eg. Hugo, Gitea). My time is limited and if you want me to fix your issue, help me help you.
30+
validations:
31+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.md

-14
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
title: "<title>"
4+
labels: ["feature request"]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an issue already exists for the feature you're requesting.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: What problem does this feature solve?
16+
description: |
17+
Please check the Chroma [README](https://github.com/alecthomas/chroma) and command-line tool to ensure this isn't an already solved problem.
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: What feature do you propose?
23+
description: |
24+
The feature should describe a change to Chroma's code, not lexers.
25+
For lexers, fill out the "Lexer request" form.
26+
validations:
27+
required: true
+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Lexer request
2+
description: Suggest the addition of a lexer
3+
title: "<title>"
4+
labels: ["help wanted", "lexer missing"]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an issue already exists for the lexer you're requesting.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: What is the missing lexer?
16+
description: |
17+
Please note that lexers are contributed by the community. Your best option is to contribute this yourself.
18+
19+
Lexers are defined in XML (see the [existing lexers](https://github.com/alecthomas/chroma/tree/master/lexers/embedded) for examples).
20+
You can test your lexer with the Chroma command-line, `chroma --lexer=my-lexer.xml example-file.lang`
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: Links to existing syntax definitions
26+
description: |
27+
Provide links to existing syntax definitions in Textmate, etc.
28+
validations:
29+
required: true

0 commit comments

Comments
 (0)
Please sign in to comment.