Skip to content

Commit 71a5e50

Browse files
committed
Updated common plaintext files (from rspec-dev) [ci skip]
1 parent aca68a0 commit 71a5e50

File tree

7 files changed

+95
-55
lines changed

7 files changed

+95
-55
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
# This file was generated on 2019-11-27T18:54:20+00:00 from the rspec-dev repo.
1+
# This file was generated on 2019-12-05T21:25:47+00:00 from the rspec-dev repo.
22
# DO NOT modify it by hand as your changes will get lost the next time it is generated.
3-
43
github: [JonRowe]
54
open_collective: rspec

BUILD_DETAIL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!---
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.
33
DO NOT modify it by hand as your changes will get lost the next time it is generated.
44
-->
55

@@ -68,8 +68,8 @@ $ bin/cucumber
6868

6969
## YARD documentation
7070

71-
RSpec uses [YARD](https://yardoc.org/) for API documentation on the [rspec.info site](https://rspec.info/).
72-
Our commitment to [SemVer](https://semver.org) requires that we explicitly
71+
RSpec uses [YARD](http://yardoc.org/) for API documentation on the [rspec.info site](http://rspec.info/).
72+
Our commitment to [SemVer](htp://semver.org) requires that we explicitly
7373
declare our public API, and our build uses YARD to ensure that every
7474
class, module and method has either been labeled `@private` or has at
7575
least some level of documentation. For new APIs, this forces us to make

CODE_OF_CONDUCT.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!---
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.
33
DO NOT modify it by hand as your changes will get lost the next time it is generated.
44
-->
55

@@ -46,14 +46,14 @@ when an individual is representing the project or its community.
4646

4747
Instances of abusive, harassing, or otherwise unacceptable behavior may be
4848
reported by contacting one of the project maintainers listed at
49-
https://rspec.info/about/. All complaints will be reviewed and investigated
49+
http://rspec.info/about/. All complaints will be reviewed and investigated
5050
and will result in a response that is deemed necessary and appropriate to the
5151
circumstances. Maintainers are obligated to maintain confidentiality with
5252
regard to the reporter of an incident.
5353

5454
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
5555
version 1.3.0, available at
56-
[https://contributor-covenant.org/version/1/3/0/][version]
56+
[http://contributor-covenant.org/version/1/3/0/][version]
5757

58-
[homepage]: https://contributor-covenant.org
59-
[version]: https://contributor-covenant.org/version/1/3/0/
58+
[homepage]: http://contributor-covenant.org
59+
[version]: http://contributor-covenant.org/version/1/3/0/

CONTRIBUTING.md

Lines changed: 14 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!---
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.
33
DO NOT modify it by hand as your changes will get lost the next time it is generated.
44
-->
55

@@ -11,10 +11,10 @@ We welcome contributions from *everyone*. While contributing, please follow the
1111
If you'd like to help make RSpec better, here are some ways you can contribute:
1212

1313
- 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))
1818
- by taking part in [feature and issue discussions](https://github.com/rspec/rspec-rails/issues)
1919
- by adding a failing test for reproducible [reported bugs](https://github.com/rspec/rspec-rails/issues)
2020
- 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
2424

2525
Thanks for helping us make RSpec better!
2626

27-
## Rspec issues labels definition
27+
## `Small` issues
2828

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.
3032

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
3434

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.
4739

4840
## Maintenance branches
4941

5042
Maintenance branches are how we manage the different supported point releases
5143
of RSpec. As such, while they might look like good candidates to merge into
5244
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.

DEVELOPMENT.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<!---
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.
33
DO NOT modify it by hand as your changes will get lost the next time it is generated.
44
-->
55

66
# Development Setup
77

88
Generally speaking, you only need to clone the project and install
9-
the dependencies with [Bundler](https://bundler.io/). You can either
9+
the dependencies with [Bundler](http://bundler.io/). You can either
1010
get a full RSpec development environment using
1111
[rspec-dev](https://github.com/rspec/rspec-dev#README) or you can
1212
set this project up individually.
@@ -22,7 +22,7 @@ Clone the repo:
2222
$ git clone [email protected]:rspec/rspec-rails.git
2323
```
2424

25-
Install the dependencies using [Bundler](https://bundler.io/):
25+
Install the dependencies using [Bundler](http://bundler.io/):
2626

2727
```
2828
$ cd rspec-rails
@@ -31,7 +31,7 @@ $ bundle install
3131

3232
To minimize boot time and to ensure we don't depend upon any extra dependencies
3333
loaded by Bundler, our CI builds avoid loading Bundler at runtime
34-
by using Bundler's [`--standalone option`](https://myronmars.to/n/dev-blog/2012/03/faster-test-boot-times-with-bundler-standalone).
34+
by using Bundler's [`--standalone option`](http://myronmars.to/n/dev-blog/2012/03/faster-test-boot-times-with-bundler-standalone).
3535
While not strictly necessary (many/most of our contributors do not do this!),
3636
if you want to exactly reproduce our CI builds you'll want to do the same:
3737

@@ -114,7 +114,7 @@ Here's a short, non-exhaustive checklist of things we typically ask contributors
114114

115115
# Adding Docs
116116

117-
RSpec uses [YARD](https://yardoc.org/) for its API documentation. To
117+
RSpec uses [YARD](http://yardoc.org/) for its API documentation. To
118118
ensure the docs render well, we recommend running a YARD server and
119119
viewing your edits in a browser.
120120

ISSUE_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
### Subject of the issue
2+
<!---
3+
Describe your issue here.
4+
-->
5+
6+
### Your environment
7+
* Ruby version:
8+
* rspec-rails version:
9+
10+
### Steps to reproduce
11+
<!---
12+
Tell us how to reproduce this issue. Please provide a working demo, you can use
13+
this [templates](REPORT_TEMPLATE.md) as a base.
14+
-->
15+
16+
### Expected behavior
17+
<!---
18+
Tell us what should happen.
19+
-->
20+
21+
### Actual behavior
22+
<!---
23+
Tell us what happens instead.
24+
-->

REPORT_TEMPLATE.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!---
2+
This file was generated on 2019-12-05T21:25:47+00:00 from the rspec-dev repo.
3+
DO NOT modify it by hand as your changes will get lost the next time it is generated.
4+
-->
5+
6+
# Report template
7+
8+
```ruby
9+
# frozen_string_literal: true
10+
11+
begin
12+
require "bundler/inline"
13+
rescue LoadError => e
14+
$stderr.puts "Bundler version 1.10 or later is required. Please update your Bundler"
15+
raise e
16+
end
17+
18+
gemfile(true) do
19+
source "https://rubygems.org"
20+
21+
gem "rspec", "3.7.0" # Activate the gem and version you are reporting the issue against.
22+
end
23+
24+
puts "Ruby version is: #{RUBY_VERSION}"
25+
require 'rspec/autorun'
26+
27+
RSpec.describe 'additions' do
28+
it 'returns 2' do
29+
expect(1 + 1).to eq(2)
30+
end
31+
32+
it 'returns 1' do
33+
expect(3 - 1).to eq(-1)
34+
end
35+
end
36+
```
37+
38+
Simply copy the content of the appropriate template into a `.rb` file on your computer
39+
and make the necessary changes to demonstrate the issue. You can execute it by running
40+
`ruby rspec_report.rb` in your terminal.
41+
42+
You can then share your executable test case as a [gist](https://gist.github.com), or
43+
simply paste the content into the issue description.

0 commit comments

Comments
 (0)