Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Select an option

  • Save gstark/436096 to your computer and use it in GitHub Desktop.

Select an option

Save gstark/436096 to your computer and use it in GitHub Desktop.
From 37e55a1ce715bdb8dfea59782edb8bad03c7fbc9 Mon Sep 17 00:00:00 2001
From: Gavin Stark <[email protected]>
Date: Sat, 12 Jun 2010 17:25:04 -0400
Subject: [PATCH] Fix instructions for commands that are either deprecated or now take slightly different options. Also add some suggestion given in the IRC channel as to how to create tickets/patches.
---
doc/contributing.txt | 11 +++++++----
doc/howto/fix_a_failing_spec.txt | 17 +++++++++++------
2 files changed, 18 insertions(+), 10 deletions(-)
diff --git a/doc/contributing.txt b/doc/contributing.txt
index dc01049..8e8e2a3 100644
--- a/doc/contributing.txt
+++ b/doc/contributing.txt
@@ -30,15 +30,18 @@ that fixes it.
3. Write Specs
- 1. Run 'bin/mspec tag --list incomplete' to show specs that have been tagged
- as incomplete. These specs may simply need review, or there could be
- specs missing for a particular class.
+ 1. Run 'bin/mspec tag --list incomplete .' to show specs that have been tagged
+ as incomplete. NOTE: You can specify a specific directory instead of '.' to
+ see incomplete specs in a specific directory. These specs may simply need
+ review, or there could be specs missing for a particular class.
2. Find unspecified behaviors. See doc/howto/write_a_ruby_spec.txt
4. Fix Failing Specs
- 1. Run 'bin/mspec tag --list fails' to show specs tagged as failing
+ 1. Run 'bin/mspec tag --list fails .' to show specs tagged as failing.
+ NOTE: You can specify a specific directory instead of '.' to see incomplete
+ specs in a specific directory.
2. Pick a spec that looks interesting and see if you can write a patch that
will make it pass.
diff --git a/doc/howto/fix_a_failing_spec.txt b/doc/howto/fix_a_failing_spec.txt
index 84496d5..3755993 100644
--- a/doc/howto/fix_a_failing_spec.txt
+++ b/doc/howto/fix_a_failing_spec.txt
@@ -5,20 +5,25 @@ Make sure you have read:
* [Getting Started](/getting_started.html)
* [The Rubinius Specs](/rubinius_specs.html)
-1. Run `rake spec` to ensure that all CI specs are passing
+1. Run `bin/mspec ci` to ensure that all CI specs are passing
1. Run `bin/mspec spec/some/spec_file.rb` to confirm the spec fails
1. Edit a file somewhere in Rubinius (probably under the kernel directory)
1. Run `rake` to build your change
1. Run `bin/mspec spec/some/spec_file.rb` to see if your spec passes
1. Repeat until your spec passes
-1. Run `rake spec:full` OR `bin/mspec ci -B full.mspec` to ensure there are
- no regressions
+1. Run `bin/mspec ci` to ensure there are no regressions
1. Change directory to Rubinius root if not already there
1. Run `git status, git add, git commit`, etc.
1. Run `git format-patch`
-1. Upload the patch in a ticket on the [Rubinius
- lighthouse](http://rubinius.lighthouseapp.com/projects/5089-rubinius/tickets)
- account
+ NOTE: most common usage is: `git format-patch origin` which will
+ extract commits the current branch accumulated since it
+ pulled from origin.
+1. Create a gist with your patch and link to it in a ticket on the issue
+ tracker at http://github.com/evanphx/rubinius/issues.
+
+ NOTE: You can add multiple patches to one ticket, but please make each
+ patch self contained and only include spec/ruby changes in a
+ patch. Don't mix spec/ruby and other rbx code in a single patch.
When your patch is accepted by the Rubinius project, you'll get a commit bit
for the Rubinius repository. You'll also get a bit for the RubySpec repository
--
1.7.1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment