-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Contributing updates v2 #1925
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Contributing updates v2 #1925
Changes from 6 commits
f4e41b5
142dd9c
643fa20
8ed95b3
dbceca2
c0b215c
c275adf
70d5a0c
5b4ac1f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,3 +23,33 @@ If you'd like to help make RSpec better, here are some ways you can contribute: | |
If you need help getting started, check out the [DEVELOPMENT](DEVELOPMENT.md) file for steps that will get you up and running. | ||
|
||
Thanks for helping us make RSpec better! | ||
|
||
## Rspec issues labels definition | ||
|
||
### `Your first PR` issues | ||
|
||
These issues are the ones that we be believe are best suited for new | ||
contributors to get started on. They represent a potential meaningful | ||
contribution to the project that should not be too hard to pull off. | ||
|
||
### `Needs reproduction case` issues | ||
|
||
These issues are ones that have been labelled by the maintainers that we | ||
believe do not currently have enough information to be reproduced the RSpec | ||
team. While not directly counted by the GitHub contribution graph, we consider | ||
helping us to reproduced the issue with a repro case as an extremely meaningful | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Again the english is correct here, apart from a typo, There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @benoittgt can we get the typo here fixed up? |
||
contribution. | ||
|
||
### `Has reproduction case` issues | ||
|
||
Issues that have reproduction cases have a repository that we can clone that | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This head would be better to start by There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do you mean this part as follows?
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The former of your suggestions is good, I like that one |
||
enable us to quickly determine the issue is valid and then start debugging | ||
within RSpec. These issues are good ones to tackle to help us actively fix bugs. | ||
|
||
## Dev environment | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This needs fleshing out :) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm sorry I have no idea for this one. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just remove it for now |
||
|
||
### Maintenance branches | ||
|
||
Maintenance branches are how we manage the different supported point releases | ||
of RSpec. As such, while they might look like good candidates to merge into | ||
master, please do not open pull requests to merge them. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
<!-- | ||
|
||
Hi there! Here's a few pointers to help us help you with your issue as quickly | ||
as possible. | ||
|
||
We prefer that the RSpec Rails issue tracker be mainly used for bug reports. | ||
Feature requests or general requests for help should go to our google group: | ||
[email protected]. We use that as our primary location for higher level | ||
RSpec discussions. | ||
|
||
If you are filing a bug report, there's a few steps it'd be super if you could | ||
follow. If you can't do all of these, don't worry, but if you can it'll help us | ||
resolve your bug faster! | ||
|
||
--> | ||
|
||
## What Ruby, Rails and RSpec versions are you using? | ||
|
||
Ruby version: | ||
Rails version: | ||
Rspec version: | ||
|
||
<!-- | ||
|
||
You can run | ||
|
||
``` | ||
bundle exec ruby --version | ||
bundle exec rails --version | ||
bundle exec rspec --version | ||
``` | ||
|
||
--> | ||
|
||
## Observed behaviour | ||
|
||
<!-- | ||
please provide a concise description of the behaviour you are observing with | ||
RSpec and Rails | ||
--> | ||
|
||
## Expected behaviour | ||
|
||
<!-- | ||
Please provide a description of what you expect to be happening, and how that | ||
differs from the current behaviour. | ||
--> | ||
|
||
## Can you provide an example app? | ||
|
||
<!-- | ||
This step is probably the most important in allowing us to quickly debug | ||
your issue, and we typically ask that you follow these steps: | ||
|
||
1. `rails new` an app at the specific version of ruby and rails that you are | ||
using | ||
2. commit that app, so that we have the rails skeleton in a separate commit | ||
3. Make all the changes necessary (adding RSpec, models, specs, controllers, | ||
etc) to reproduce the issue. There should be a failing test or tests that you | ||
expect to pass. We'll run `bundle exec rspec`, but if you can provide a | ||
readme with more detailed instructions that'd be amazing :) | ||
4. Commit | ||
5. Provide a link to a github repo, a description of the app and what you're expecting here | ||
--> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
get started on
→get started
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
get started on
is the correct english here, an alternative would beget started with
.