Permalink
Browse files

Update Contributing to the Rails Code guide for automatically change …

…the status of LH tickets
  • Loading branch information...
1 parent beed866 commit 02883a1090e327b115c12c3f1dc97f1474ef3c9f @smartinez87 smartinez87 committed Apr 14, 2011
Showing with 10 additions and 4 deletions.
  1. +10 −4 railties/guides/source/contributing_to_ruby_on_rails.textile
View
14 railties/guides/source/contributing_to_ruby_on_rails.textile
@@ -314,14 +314,20 @@ You should not be the only person who looks at the code before you submit it. Yo
You might also want to check out the "RailsBridge BugMash":http://wiki.railsbridge.org/projects/railsbridge/wiki/BugMash as a way to get involved in a group effort to improve Rails. This can help you get started and help check your code when you're writing your first patches.
+h4. Create a Lighthouse Ticket
+
+Now create a ticket for your patch. Go to the "new ticket":http://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/new page at Lighthouse. Fill in a reasonable title and description, as well as tag the ticket with the ‘patch’ tag and whatever other subject area tags make sense. Write down your ticket number, for you will need it in the following step.
+
h4. Commit Your Changes
When you're happy with the code on your computer, you need to commit the changes to git:
<shell>
-$ git commit -a -m "Here is a commit message"
+$ git commit -a -m "[#ticket_number state:committed] Here is a commit message"
</shell>
+NOTE: By adding '[#ticket_number state:committed]' on your commit message, the ticket will automatically change its status to commited once your patch is pushed to the repository.
+
h4. Update master
It’s pretty likely that other changes to master have happened while you were working. Go get them:
@@ -364,10 +370,9 @@ Please make sure the patch does not introduce whitespace errors:
$ git apply --whitespace=error-all my_new_patch.diff
</shell>
+h4. Attach your Patch to the Lighthouse Ticket
-h4. Create a Lighthouse Ticket
-
-Now create a ticket with your patch. Go to the "new ticket":http://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/new page at Lighthouse. Fill in a reasonable title and description, remember to attach your patch file, and tag the ticket with the ‘patch’ tag and whatever other subject area tags make sense.
+Now you need to update the ticket by attaching the patch file you just created.
h4. Get Some Feedback
@@ -385,6 +390,7 @@ All contributions, either via master or docrails, get credit in "Rails Contribut
h3. Changelog
+* April 14, 2001: Modified Contributing to the Rails Code section to add '[#ticket_number state:commited]' on patches commit messages by "Sebastian Martinez":http://wyeworks.com
* December 28, 2010: Complete revision by "Xavier Noria":credits.html#fxn
* April 6, 2010: Fixed document to validate XHTML 1.0 Strict. "Jaime Iniesta":http://jaimeiniesta.com
* August 1, 2009: Updates/amplifications by "Mike Gunderloy":credits.html#mgunderloy

0 comments on commit 02883a1

Please sign in to comment.