1
1
<!-- -
2
- This file was generated on 2015 -12-07T22:01:06+11 :00 from the rspec-dev repo.
2
+ This file was generated on 2019 -12-05T21:25:47+00 :00 from the rspec-dev repo.
3
3
DO NOT modify it by hand as your changes will get lost the next time it is generated.
4
4
-->
5
5
@@ -11,10 +11,10 @@ We welcome contributions from *everyone*. While contributing, please follow the
11
11
If you'd like to help make RSpec better, here are some ways you can contribute:
12
12
13
13
- by running RSpec HEAD to help us catch bugs before new releases
14
- - by [ reporting bugs you encounter] ( https://github.com/rspec/rspec-rails/issues/new? template=bug_report.md )
15
- - by [ suggesting new features] ( https://github.com/rspec/rspec-rails/issues/new?template=feature_request.md )
16
- - by improving RSpec's [ Relish] ( https://relishapp.com/rspec ) or [ API] ( https ://rspec.info/documentation/) documentation
17
- - by improving [ RSpec's website] ( https ://rspec.info/) ([ source] ( https://github.com/rspec/rspec.github.io ) )
14
+ - by [ reporting bugs you encounter] ( https://github.com/rspec/rspec-rails/issues/new ) with [ report template] ( #report-template )
15
+ - by [ suggesting new features] ( https://github.com/rspec/rspec-rails/issues/new )
16
+ - by improving RSpec's [ Relish] ( https://relishapp.com/rspec ) or [ API] ( http ://rspec.info/documentation/) documentation
17
+ - by improving [ RSpec's website] ( http ://rspec.info/) ([ source] ( https://github.com/rspec/rspec.github.io ) )
18
18
- by taking part in [ feature and issue discussions] ( https://github.com/rspec/rspec-rails/issues )
19
19
- by adding a failing test for reproducible [ reported bugs] ( https://github.com/rspec/rspec-rails/issues )
20
20
- by reviewing [ pull requests] ( https://github.com/rspec/rspec-rails/pulls ) and suggesting improvements
@@ -24,47 +24,21 @@ If you need help getting started, check out the [DEVELOPMENT](DEVELOPMENT.md) fi
24
24
25
25
Thanks for helping us make RSpec better!
26
26
27
- ## Rspec issues labels definition
27
+ ## ` Small ` issues
28
28
29
- ### ` Your first PR ` issues
29
+ These issue are ones that we be believe are best suited for new contributors to
30
+ get started with. They represent a meaningful contribution to the project that
31
+ should not be too hard to pull off.
30
32
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.
33
+ ## Report template
34
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.
35
+ Having a way to reproduce your issue will be very helpful for others to help confirm,
36
+ investigate and ultimately fix your issue. You can do this by providing an executable
37
+ test case. To make this process easier, we have prepared one basic
38
+ [ bug report templates] ( REPORT_TEMPLATE.md ) for you to use as a starting point.
47
39
48
40
## Maintenance branches
49
41
50
42
Maintenance branches are how we manage the different supported point releases
51
43
of RSpec. As such, while they might look like good candidates to merge into
52
44
master, please do not open pull requests to merge them.
53
-
54
- ## How do the cukes work?
55
-
56
- The cucumber features for RSpec rails document how it works, but are also quasi
57
- executable tests for the framework. They execute in the context of a pre-setup
58
- Rails app.
59
-
60
- 1 . Before the cucumber specs run, the directory ` tmp/aruba ` is cleared
61
- 2 . If the example app hasn't already been created,
62
- ` bundle exec rake generate:app generate:stuff ` is executed.
63
- 3 . The example app is copied in to ` tmp/aruba `
64
- 4 . Everything in ` tmp/aruba/spec/* ` is deleted apart from ` spec/spec_helper.rb ` and
65
- ` spec/rails_helper.rb `
66
- 5 . the cucumber suite executes, creating files in that app and executing them
67
-
68
- The best way to debug the app is to run a failing cucumber feature, which will
69
- leave the test files intact in ` tmp/aruba ` , then you can cd in to that director
70
- and run it in the bundle context of the aruba app.
0 commit comments