Warning: preg_match(): Compilation failed: group name must start with a non-digit at offset 8 in /home/jacius/rubygame/w/includes/MagicWord.php on line 722

Warning: preg_match(): Compilation failed: group name must start with a non-digit at offset 8 in /home/jacius/rubygame/w/includes/MagicWord.php on line 722

Warning: preg_match_all(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 700

Warning: Invalid argument supplied for foreach() in /home/jacius/rubygame/w/includes/MagicWord.php on line 701

Warning: preg_replace(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 705

Warning: preg_match_all(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 700

Warning: Invalid argument supplied for foreach() in /home/jacius/rubygame/w/includes/MagicWord.php on line 701

Warning: preg_replace(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 705

Warning: preg_match_all(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 700

Warning: Invalid argument supplied for foreach() in /home/jacius/rubygame/w/includes/MagicWord.php on line 701

Warning: preg_replace(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 705

Warning: preg_match_all(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 700

Warning: Invalid argument supplied for foreach() in /home/jacius/rubygame/w/includes/MagicWord.php on line 701

Warning: preg_replace(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 705

Warning: preg_match(): Compilation failed: group name must start with a non-digit at offset 8 in /home/jacius/rubygame/w/includes/MagicWord.php on line 722

Warning: preg_match_all(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 700

Warning: Invalid argument supplied for foreach() in /home/jacius/rubygame/w/includes/MagicWord.php on line 701

Warning: preg_replace(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 705

Warning: preg_match_all(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 700

Warning: Invalid argument supplied for foreach() in /home/jacius/rubygame/w/includes/MagicWord.php on line 701

Warning: preg_replace(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 705

Warning: preg_match_all(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 700

Warning: Invalid argument supplied for foreach() in /home/jacius/rubygame/w/includes/MagicWord.php on line 701

Warning: preg_replace(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 705

Warning: preg_match_all(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 700

Warning: Invalid argument supplied for foreach() in /home/jacius/rubygame/w/includes/MagicWord.php on line 701

Warning: preg_replace(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 705

Warning: preg_match_all(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 700

Warning: Invalid argument supplied for foreach() in /home/jacius/rubygame/w/includes/MagicWord.php on line 701

Warning: preg_replace(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 705

Warning: preg_match_all(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 700

Warning: Invalid argument supplied for foreach() in /home/jacius/rubygame/w/includes/MagicWord.php on line 701

Warning: preg_replace(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 705

Warning: preg_match_all(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 700

Warning: Invalid argument supplied for foreach() in /home/jacius/rubygame/w/includes/MagicWord.php on line 701

Warning: preg_replace(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 705

Warning: preg_match_all(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 700

Warning: Invalid argument supplied for foreach() in /home/jacius/rubygame/w/includes/MagicWord.php on line 701

Warning: preg_replace(): Compilation failed: group name must start with a non-digit at offset 4 in /home/jacius/rubygame/w/includes/MagicWord.php on line 705

Warning: preg_match(): Compilation failed: group name must start with a non-digit at offset 8 in /home/jacius/rubygame/w/includes/MagicWord.php on line 722

Warning: preg_match(): Compilation failed: group name must start with a non-digit at offset 8 in /home/jacius/rubygame/w/includes/MagicWord.php on line 722

Warning: preg_match(): Compilation failed: group name must start with a non-digit at offset 8 in /home/jacius/rubygame/w/includes/MagicWord.php on line 722

Warning: preg_match(): Compilation failed: group name must start with a non-digit at offset 8 in /home/jacius/rubygame/w/includes/MagicWord.php on line 722
How to Contribute - Rubygame

How to Contribute


Warning: preg_match(): Compilation failed: group name must start with a non-digit at offset 8 in /home/jacius/rubygame/w/includes/MagicWord.php on line 722
From Rubygame

Jump to: navigation, search
(Ported from the Github wiki)
(Updated, restructured, and cleaned up)
Line 2: Line 2:
This is a brief guide for anyone who is interested in helping improve Rubygame by contributing code changes — bug fixes, new features, etc.
This is a brief guide for anyone who is interested in helping improve Rubygame by contributing code changes — bug fixes, new features, etc.
-
Finding Out What Needs To Be Done
 
-
If you want to help out, but aren’t sure what needs to be done, you’ve got several options to choose from:
+
== Finding out what needs to be done ==
-
* '''Check the list.''' There’s a [http://jacius.lighthouseapp.com/projects/12816-rubygame/tickets?q=state%3Aopen list of open tickets] on Lighthouse. Pick one that seems within your abilities, and have at it.
+
If you want to help out, but aren't sure what needs to be done, you’ve got several options to choose from:
-
* '''Ask me.''' Send me an email: jacius at gmail. I usually have a good idea of what needs to be done, even if I haven’t made tickets for it.
+
 
 +
* '''Check the list.''' There's a [http://github.com/rubygame/rubygame/issues list of open issues] on GitHub. Pick one that seems within your abilities, and have at it.
 +
* '''Ask me.''' Send me an email: jacius at gmail. I usually have a good idea of what needs to be done, even if I haven't filed issues for them.
* '''Scratch your itch.''' If you have an idea of something that should be added, fixed, or improved… go for it!
* '''Scratch your itch.''' If you have an idea of something that should be added, fixed, or improved… go for it!
-
== The How-To’s ==
+
== Submitting the change ==
 +
 
 +
If you want to contribute to Rubygame, the best way to do it is to [http://help.github.com/fork-a-repo/ fork] the [http://github.com/rubygame/rubygame/ Rubygame repository], make a change, then [http://help.github.com/pull-requests/ send a pull request].
 +
 
 +
== Give yourself credit ==
 +
 
 +
When you make any change, add an entry to the CREDITS file with your name, email, a brief summary of the change, and the date:
 +
<pre>
 +
- <b>Chris Contributor</b>
 +
  Email::        chris.contributor at email.com
 +
  Contribution::  Added Rubygame::FancyFeature class.
 +
  Date::          2011-12-13
 +
</pre>
 +
 
 +
'''Additionally''', update or create the copyright header in every file you modified/created. The way you do that is different for existing files that you modified, or new files that you created:
 +
 
 +
=== Existing files that you modified ===
 +
 
 +
If you modified any existing files, add a note at the bottom of the copyright/license header in every file you modified:
 +
 
 +
<pre>
 +
# (...)
 +
#
 +
# You should have received a copy of the GNU Lesser General Public
 +
# License along with this library; if not, write to the Free Software
 +
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 +
#
 +
#
 +
# Changes:
 +
# * Chris Contributor, 2011-12-13:
 +
#  Added Rubygame::FancyFeature class.
 +
#
 +
#++</pre>
 +
 
 +
=== New files that you created ===
-
If you want to contribute to Rubygame, the best way to do it is to create a fork, make a change, and send a pull request back to me. There’s a [http://railsontherun.com/2008/3/3/how-to-use-github-and-submit-a-patch pretty good tutorial at Rails on the Run] about how to do that.
+
If you created any new files from scratch, copy the copyright/license header from another file, but use your name in the copyright information:
-
Another, much less convenient way is to submit a patch on [http://jacius.lighthouseapp.com/projects/12816-rubygame/overview Rubygame @ Lighthouse]. Make a new ticket, describe your changes, and attach your patch(es). You’ll need to sign up for a Lighthouse account to do that, if you don’t have one already.
+
<pre>
 +
#--
 +
# This file is one part of:
 +
# Rubygame -- Ruby code and bindings to SDL to facilitate game creation
 +
#
 +
# Copyright (C) 2011  Chris Contributor
 +
#
 +
# This library is free software; you can redistribute it and/or
 +
# modify it under the terms of the GNU Lesser General Public
 +
# License as published by the Free Software Foundation; either
 +
# version 2.1 of the License, or (at your option) any later version.
 +
#
 +
# (...)
 +
</pre>
-
== Policy Stuff ==
+
== Policy stuff ==
-
This is stuff you should do to make accepting your changes easier for me (and thus more likely that I’ll accept them):
+
This is stuff you should do to make accepting your changes easier for me (and thus more likely that I'll accept them):
-
# '''Use topic branches.''' Make a branch for your changes, instead of working directly in ‘master’. This helps me keep track of which commits are relevant. One branch per logical change, please.
+
* '''Use topic branches.''' Make a new branch based on 'next' for your changes. This helps me keep track of which commits are relevant. One branch per logical change, please.</li>
-
# '''Spec it.''' A change (feature, bugfix, whatever) that comes with specs is much nicer than a change without, even if the specs aren’t comprehensive.
+
* '''Spec it.''' A change (feature, bugfix, whatever) that comes with specs is much nicer than a change without, even if the specs aren’t comprehensive.
-
# '''Give yourself credit.''' Add an entry to the CREDITS file with your name, email, date, and a brief summary of the change. Also, add your full, real name to the copyright notice for any files you make significant changes to, e.g. “Copyright © 2008 John Croisant, [Your Name]”.
+
* '''LGPL “v2.1 or later”.''' All the source in Rubygame is licensed as GNU LGPL “version 2.1 or later”. If you add a new source file, it must be licensed under the same terms, or I simply will not accept it. Be sure to add the LGPL header to the top of the source file, using your name in the copyright section, as described in the [[#Give yourself credit|Give yourself credit]] section above.
-
# '''LGPL “v2.1 or later”.''' All the source in Rubygame is licensed as GNU LGPL “version 2.1 or later”. If you add a new source file, it must be licensed under the same terms, or I simply will not accept it. Be sure to add the LGPL header to the top of the source file, using your name in the copyright section.
+

Revision as of 16:46, 14 April 2011

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox