Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Clarifying need of spec and commit message

  • Loading branch information...
commit c4b1272ddf6577d63395aba67697a9d3266c6bf7 1 parent 03d212e
@jc00ke jc00ke authored
Showing with 3 additions and 2 deletions.
  1. +3 −2 CONTRIBUTING.md
View
5 CONTRIBUTING.md
@@ -11,15 +11,16 @@ Please include the following:
1. RVM/rbenv/chruby/etc version or the commit hash from git if you're building off of a clone
1. Stack trace (preferably as a gist, since they're easier to read)
1. If you can add a failing spec, that's great!
+1. Please include the simplest possible reproduction you can. This last point is vital to fixing issues.
## Fixing a bug
1. Fork the repo
1. Create a topic branch
-1. Include a spec! Pull requests without a spec will be delayed. The spec should be in a separate commit, and it should include an mspec tag.
+1. Include a spec, if appropriate. Pull requests that need a spec but are submitted without one will be delayed until one is written. The spec should be in a separate commit.
1. Please follow the [Coding Style Guide](http://rubini.us/doc/en/contributing/style-guide)
1. ALWAYS RUN THE FULL SPEC SUITE! `rake` will run the VM specs, plus all `1.8` and `1.9` specs.
-1. Please add a detailed commit message. Here is a [fantastic example](https://github.com/rubinius/rubinius/commit/1f9ddd10c10386f4e12f9a52f41ff77731061612) by @ryoqun.
+1. Please add a detailed commit message. Here is a [fantastic example](https://github.com/rubinius/rubinius/commit/1f9ddd10c10386f4e12f9a52f41ff77731061612) by @ryoqun. The preference is for a (max) 50 character summary as line one, a blank line, then any number of lines, no longer than 80 characters.
1. Send in that pull request!
1. Follow up with us on the ticket if we haven't merged or commented in a few days. We strive to address issues in a reasonable time. If we miss yours, please remind us.
Please sign in to comment.
Something went wrong with that request. Please try again.