Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 52 lines (41 sloc) 2.221 kb
14e3ed1 @jc00ke Fixing formatting issues [ci skip]
jc00ke authored
1 We want to start off by saying thank you for using Rubinius. This project is a
b50d39b @jc00ke Wrap on 80 characters [ci skip]
jc00ke authored
2 labor of love, and we appreciate all of the users that catch bugs, make
3 performance improvements, and help with documentation. Every contribution is
4 meaningful, so thank you for participating. That being said, here are a few
5 guidelines that we ask you to follow so we can successfully address your issue.
03d212e @jc00ke Adding first draft of contributing guidelines
jc00ke authored
6
5a1e3ba @jc00ke Convert from markdown to plain text [ci skip]
jc00ke authored
7 1. Submitting Issues
03d212e @jc00ke Adding first draft of contributing guidelines
jc00ke authored
8
9 Please include the following:
10
14e3ed1 @jc00ke Fixing formatting issues [ci skip]
jc00ke authored
11 * The Rubinius version (rbx -v)
12 * Your OS (uname -a) RVM/rbenv/chruby/etc version or the commit hash from git
13 if you're building off of a clone
b50d39b @jc00ke Wrap on 80 characters [ci skip]
jc00ke authored
14 * Stack trace (preferably as a gist, since they're easier to read) If you can
14e3ed1 @jc00ke Fixing formatting issues [ci skip]
jc00ke authored
15 add a failing spec, that's great!
16 * Please include the simplest possible reproduction you can. This last point is
17 vital to fixing issues.
5a1e3ba @jc00ke Convert from markdown to plain text [ci skip]
jc00ke authored
18
19 2. Fixing a bug
20
b50d39b @jc00ke Wrap on 80 characters [ci skip]
jc00ke authored
21 * Fork the repo Create a topic branch Include a spec, if appropriate.
22 Pull requests that need a spec but are submitted without one will be delayed
14e3ed1 @jc00ke Fixing formatting issues [ci skip]
jc00ke authored
23 until one is written. The spec should be in a separate commit.
b50d39b @jc00ke Wrap on 80 characters [ci skip]
jc00ke authored
24 * Please follow the Coding Style Guide at
14e3ed1 @jc00ke Fixing formatting issues [ci skip]
jc00ke authored
25 http://rubini.us/doc/en/contributing/style-guide
26 * ALWAYS RUN THE FULL SPEC SUITE! rake will run the VM specs, plus all 1.8 and
27 1.9 specs.
28 * Please add a * detailed commit message. Here is a fantastic example by
29 @ryoqun https://github.com/rubinius/rubinius/commit/1f9ddd1
b50d39b @jc00ke Wrap on 80 characters [ci skip]
jc00ke authored
30 The preference is for a (max) 50 character summary as line one, a blank line,
31 then any number of lines, no longer than 80 characters.
14e3ed1 @jc00ke Fixing formatting issues [ci skip]
jc00ke authored
32 * Send in that pull request!
33 * Follow up with us on the ticket if we haven't merged or commented in a few
34 days. We strive to address issues in a reasonable time. If we miss yours,
35 please remind us.
5a1e3ba @jc00ke Convert from markdown to plain text [ci skip]
jc00ke authored
36
37 3. Performance patches
03d212e @jc00ke Adding first draft of contributing guidelines
jc00ke authored
38
39 We love these!
40
14e3ed1 @jc00ke Fixing formatting issues [ci skip]
jc00ke authored
41 * Include benchmarks before and after the change. Please include your hardware
42 specs, namely CPU speed, # of cores, speed of hard drive (if SSD, then SSD is
43 fine) and amount of RAM.
b50d39b @jc00ke Wrap on 80 characters [ci skip]
jc00ke authored
44 * ALWAYS RUN THE FULL SPEC SUITE! rake will ensure you didn't accidentally
45 break anything.
03d212e @jc00ke Adding first draft of contributing guidelines
jc00ke authored
46
b50d39b @jc00ke Wrap on 80 characters [ci skip]
jc00ke authored
47 For more details on how to contribute, please see Contributing to Rubinius
48 http://rubini.us/2011/10/18/contributing-to-rubinius/ Also, feel free to hang
49 out in #rubinius on Freenode.
03d212e @jc00ke Adding first draft of contributing guidelines
jc00ke authored
50
51 Again, thank you!
Something went wrong with that request. Please try again.