Merge pull request #351 from benoittgt/update-common-markdown-files-2018-04-17-for-master

Updated common markdown files (from rspec-dev) [ci skip]

Author: JonRowe

BUILD_DETAIL.md

@@ -1,5 +1,5 @@
 <!---
-This file was generated on 2016-09-28T20:00:39+10:00 from the rspec-dev repo.
+This file was generated on 2018-04-17T19:41:57+02:00 from the rspec-dev repo.
 DO NOT modify it by hand as your changes will get lost the next time it is generated.
 -->
 

CODE_OF_CONDUCT.md

@@ -1,5 +1,5 @@
 <!---
-This file was generated on 2016-09-28T20:00:39+10:00 from the rspec-dev repo.
+This file was generated on 2018-04-17T19:41:57+02:00 from the rspec-dev repo.
 DO NOT modify it by hand as your changes will get lost the next time it is generated.
 -->
 

CONTRIBUTING.md

@@ -1,5 +1,5 @@
 <!---
-This file was generated on 2016-09-28T20:00:39+10:00 from the rspec-dev repo.
+This file was generated on 2018-04-17T19:41:57+02:00 from the rspec-dev repo.
 DO NOT modify it by hand as your changes will get lost the next time it is generated.
 -->
 
@@ -11,7 +11,7 @@ We welcome contributions from *everyone*. While contributing, please follow the
 If you'd like to help make RSpec better, here are some ways you can contribute:
 
   - by running RSpec HEAD to help us catch bugs before new releases
-  - by [reporting bugs you encounter](https://github.com/rspec/rspec-support/issues/new)
+  - by [reporting bugs you encounter](https://github.com/rspec/rspec-support/issues/new) with [report template](#report-template)
   - by [suggesting new features](https://github.com/rspec/rspec-support/issues/new)
   - by improving RSpec's [Relish](https://relishapp.com/rspec) or [API](http://rspec.info/documentation/) documentation
   - by improving [RSpec's website](http://rspec.info/) ([source](https://github.com/rspec/rspec.github.io))
@@ -30,6 +30,13 @@ These issue are ones that we be believe are best suited for new contributors to
 get started with. They represent a meaningful contribution to the project that
 should not be too hard to pull off.
 
+## Report template
+
+Having a way to reproduce your issue will be very helpful for others to help confirm,
+investigate and ultimately fix your issue. You can do this by providing an executable
+test case. To make this process easier, we have prepared one basic
+[bug report templates](REPORT_TEMPLATE.md) for you to use as a starting point.
+
 ## Maintenance branches
 
 Maintenance branches are how we manage the different supported point releases

DEVELOPMENT.md

@@ -1,5 +1,5 @@
 <!---
-This file was generated on 2016-09-28T20:00:39+10:00 from the rspec-dev repo.
+This file was generated on 2018-04-17T19:41:57+02:00 from the rspec-dev repo.
 DO NOT modify it by hand as your changes will get lost the next time it is generated.
 -->
 

ISSUE_TEMPLATE.md

@@ -0,0 +1,24 @@
+### Subject of the issue
+<!---
+Describe your issue here.
+-->
+
+### Your environment
+* Ruby version:
+* rspec-support version:
+
+### Steps to reproduce
+<!---
+Tell us how to reproduce this issue. Please provide a working demo, you can use
+this [templates](REPORT_TEMPLATE.md) as a base.
+-->
+
+### Expected behavior
+<!---
+Tell us what should happen.
+-->
+
+### Actual behavior
+<!---
+Tell us what happens instead.
+-->

REPORT_TEMPLATE.md

@@ -0,0 +1,43 @@
+<!---
+This file was generated on 2018-04-17T19:41:57+02:00 from the rspec-dev repo.
+DO NOT modify it by hand as your changes will get lost the next time it is generated.
+-->
+
+# Report template
+
+```ruby
+# frozen_string_literal: true
+
+begin
+  require "bundler/inline"
+rescue LoadError => e
+  $stderr.puts "Bundler version 1.10 or later is required. Please update your Bundler"
+  raise e
+end
+
+gemfile(true) do
+  source "https://rubygems.org"
+
+  gem "rspec", "3.7.0" # Activate the gem and version you are reporting the issue against.
+end
+
+puts "Ruby version is: #{RUBY_VERSION}"
+require 'rspec/autorun'
+
+RSpec.describe 'additions' do
+  it 'returns 2' do
+    expect(1 + 1).to eq(2)
+  end
+
+  it 'returns 1' do
+    expect(3 - 1).to eq(-1)
+  end
+end
+```
+
+Simply copy the content of the appropriate template into a `.rb` file on your computer
+and make the necessary changes to demonstrate the issue. You can execute it by running
+`ruby rspec_report.rb` in your terminal.
+
+You can then share your executable test case as a [gist](https://gist.github.com), or
+simply paste the content into the issue description.