Skip to content

Commit 954e03b

Browse files
committed
github: add issue templates
I am getting tired of asking people for reproductions. Hopefully these issue templates will help with that.
1 parent 04e025b commit 954e03b

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: An issue with the current behavior of the regex crate.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
10+
#### What version of regex are you using?
11+
12+
If it isn't the latest version, then please upgrade and check whether the bug
13+
is still present.
14+
15+
#### Describe the bug at a high level.
16+
17+
Give a brief description of the actual problem you're observing.
18+
19+
#### What are the steps to reproduce the behavior?
20+
21+
This section should almost always provide a COMPLETE Rust program that others
22+
can compile and run with Cargo. It should be as small as possible.
23+
24+
If providing a small and simple reproduction is not easy, please explain why
25+
and the maintainers will help you figure out next steps.
26+
27+
#### What is the actual behavior?
28+
29+
If you provide a Rust program in the previous section, then this should be the
30+
output of that program.
31+
32+
#### What is the expected behavior?
33+
34+
What do you expect the output to be?

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Ask a question
4+
about: |
5+
You've come to seek help or want to discuss something related to ripgrep.
6+
url: https://github.com/rust-lang/regex/discussions/new
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
10+
#### Describe your feature request
11+
12+
Please describe the behavior you want and the motivation. Please also provide
13+
examples of how the new feature would be used if your feature request were
14+
added.
15+
16+
The best kind of feature request is one that proposes a concrete change to the
17+
API along with a sketch of the changes to the public API documentation.
18+
19+
If you're not sure what to write here, then try imagining what the ideal
20+
documentation of your new feature would look like. Then try to write it.

0 commit comments

Comments
 (0)