Skip to content

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

Merged
merged 9 commits into from
Apr 24, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,30 @@ 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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

get started onget started

Copy link
Member

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 be get started with.

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 reproduce the issue with a repro case as an extremely meaningful
contribution.

### `Has reproduction case` issues

These issues are the ones that have reproduction cases, able to start working on
immediately. These are good ones to tackle to help us actively fix bugs.

## 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.
64 changes: 64 additions & 0 deletions ISSUE_TEMPLATE.md
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
-->