Skip to content

Commit 55a15bb

Browse files
authored
Merge pull request #1925 from benoittgt/contributing-updates-v2
Contributing updates v2
2 parents 259dc3b + 5b4ac1f commit 55a15bb

File tree

2 files changed

+91
-0
lines changed

2 files changed

+91
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,30 @@ If you'd like to help make RSpec better, here are some ways you can contribute:
2323
If you need help getting started, check out the [DEVELOPMENT](DEVELOPMENT.md) file for steps that will get you up and running.
2424

2525
Thanks for helping us make RSpec better!
26+
27+
## Rspec issues labels definition
28+
29+
### `Your first PR` issues
30+
31+
These issues are the ones that we be believe are best suited for new
32+
contributors to get started on. They represent a potential meaningful
33+
contribution to the project that should not be too hard to pull off.
34+
35+
### `Needs reproduction case` issues
36+
37+
These issues are ones that have been labelled by the maintainers that we
38+
believe do not currently have enough information to be reproduced the RSpec
39+
team. While not directly counted by the GitHub contribution graph, we consider
40+
helping us to reproduce the issue with a repro case as an extremely meaningful
41+
contribution.
42+
43+
### `Has reproduction case` issues
44+
45+
These issues are the ones that have reproduction cases, able to start working on
46+
immediately. These are good ones to tackle to help us actively fix bugs.
47+
48+
## Maintenance branches
49+
50+
Maintenance branches are how we manage the different supported point releases
51+
of RSpec. As such, while they might look like good candidates to merge into
52+
master, please do not open pull requests to merge them.

ISSUE_TEMPLATE.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<!--
2+
3+
Hi there! Here's a few pointers to help us help you with your issue as quickly
4+
as possible.
5+
6+
We prefer that the RSpec Rails issue tracker be mainly used for bug reports.
7+
Feature requests or general requests for help should go to our google group:
8+
[email protected]. We use that as our primary location for higher level
9+
RSpec discussions.
10+
11+
If you are filing a bug report, there's a few steps it'd be super if you could
12+
follow. If you can't do all of these, don't worry, but if you can it'll help us
13+
resolve your bug faster!
14+
15+
-->
16+
17+
## What Ruby, Rails and RSpec versions are you using?
18+
19+
Ruby version:
20+
Rails version:
21+
Rspec version:
22+
23+
<!--
24+
25+
You can run
26+
27+
```
28+
bundle exec ruby --version
29+
bundle exec rails --version
30+
bundle exec rspec --version
31+
```
32+
33+
-->
34+
35+
## Observed behaviour
36+
37+
<!--
38+
please provide a concise description of the behaviour you are observing with
39+
RSpec and Rails
40+
-->
41+
42+
## Expected behaviour
43+
44+
<!--
45+
Please provide a description of what you expect to be happening, and how that
46+
differs from the current behaviour.
47+
-->
48+
49+
## Can you provide an example app?
50+
51+
<!--
52+
This step is probably the most important in allowing us to quickly debug
53+
your issue, and we typically ask that you follow these steps:
54+
55+
1. `rails new` an app at the specific version of ruby and rails that you are
56+
using
57+
2. commit that app, so that we have the rails skeleton in a separate commit
58+
3. Make all the changes necessary (adding RSpec, models, specs, controllers,
59+
etc) to reproduce the issue. There should be a failing test or tests that you
60+
expect to pass. We'll run `bundle exec rspec`, but if you can provide a
61+
readme with more detailed instructions that'd be amazing :)
62+
4. Commit
63+
5. Provide a link to a github repo, a description of the app and what you're expecting here
64+
-->

0 commit comments

Comments
 (0)