Skip to content

Commit 5850cf3

Browse files
authored
Merge pull request #1978 from rubocop/add-issue-templete
Add issue templates for bug reports and feature requests
2 parents 10332a2 + c91e9d6 commit 5850cf3

File tree

2 files changed

+68
-0
lines changed

2 files changed

+68
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: Bug Report
3+
about: Report an issue with RuboCop RSpec you've discovered.
4+
---
5+
6+
*Be clear, concise and precise in your description of the problem.
7+
Open an issue with a descriptive title and a summary in grammatically correct,
8+
complete sentences.*
9+
10+
*Use the template below when reporting bugs. Please, make sure that
11+
you're running the latest stable RuboCop RSpec and that the problem you're reporting
12+
hasn't been reported (and potentially fixed) already.*
13+
14+
*Before filing the ticket you should replace all text above the horizontal
15+
rule with your own words.*
16+
17+
*In the case of false positive or false negative, please add the
18+
corresponding cop name.*
19+
20+
______________________________________________________________________
21+
22+
## Expected behavior
23+
24+
Describe here how you expected RuboCop RSpec to behave in this particular situation.
25+
26+
## Actual behavior
27+
28+
Describe here what actually happened.
29+
Please use `rubocop --debug` when pasting rubocop output as it contains additional information.
30+
31+
## Steps to reproduce the problem
32+
33+
This is extremely important! Providing us with a reliable way to reproduce
34+
a problem will expedite its solution.
35+
36+
## RuboCop RSpec version
37+
38+
Include the output of `rubocop -V` or `bundle exec rubocop -V` if using Bundler.
39+
If you see extension cop versions (e.g. `rubocop-performance`, `rubocop-rake`, and others)
40+
output by `rubocop -V`, include them as well. Here's an example:
41+
42+
```shell
43+
$ [bundle exec] rubocop -V
44+
1.67.0 (using Parser 3.3.5.0, rubocop-ast 1.32.3, analyzing as Ruby 2.7, running on ruby 3.4.0) [arm64-darwin23]
45+
- rubocop-performance 1.22.1
46+
- rubocop-rake 0.6.0
47+
- rubocop-rspec 3.1.0
48+
```
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 new RuboCop RSpec features or improvements to existing features.
4+
---
5+
6+
## Is your feature request related to a problem? Please describe.
7+
8+
A clear and concise description of what the problem is. Ex. I'm always frustrated when \[...\]
9+
10+
## Describe the solution you'd like
11+
12+
A clear and concise description of what you want to happen.
13+
14+
## Describe alternatives you've considered
15+
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
## Additional context
19+
20+
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)