Skip to content

Commit

Permalink
github: add issue templates
Browse files Browse the repository at this point in the history
I am getting tired of asking people for reproductions. Hopefully these
issue templates will help with that.
  • Loading branch information
BurntSushi committed Dec 29, 2020
1 parent 04e025b commit 954e03b
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug report
about: An issue with the current behavior of the regex crate.
title: ''
labels: ''
assignees: ''
---


#### What version of regex are you using?

If it isn't the latest version, then please upgrade and check whether the bug
is still present.

#### Describe the bug at a high level.

Give a brief description of the actual problem you're observing.

#### What are the steps to reproduce the behavior?

This section should almost always provide a COMPLETE Rust program that others
can compile and run with Cargo. It should be as small as possible.

If providing a small and simple reproduction is not easy, please explain why
and the maintainers will help you figure out next steps.

#### What is the actual behavior?

If you provide a Rust program in the previous section, then this should be the
output of that program.

#### What is the expected behavior?

What do you expect the output to be?
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
blank_issues_enabled: true
contact_links:
- name: Ask a question
about: |
You've come to seek help or want to discuss something related to ripgrep.
url: https://github.com/rust-lang/regex/discussions/new
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest a new feature
title: ''
labels: ''
assignees: ''
---


#### Describe your feature request

Please describe the behavior you want and the motivation. Please also provide
examples of how the new feature would be used if your feature request were
added.

The best kind of feature request is one that proposes a concrete change to the
API along with a sketch of the changes to the public API documentation.

If you're not sure what to write here, then try imagining what the ideal
documentation of your new feature would look like. Then try to write it.

0 comments on commit 954e03b

Please sign in to comment.