git.debu.gs Git - rubygems/blob - CONTRIBUTING.rdoc

   1 = How to contribute
   2
   3 Community involvement is essential to RubyGems. We want to keep it easy as
   4 possible to contribute changes. There are a few guidelines that we need
   5 contributors to follow to reduce the time it takes to get changes merged in.
   6
   7 == Guidelines
   8
   9 1. New features should be coupled with tests.
  10
  11 2. Ensure that your code blends well with ours:
  12    * No trailing whitespace
  13    * Match indentation (two spaces)
  14    * Match coding style (`if`, `elsif`, `when` need trailing `then`)
  15
  16 3. Don't modify the history file or version number.
  17
  18 4. If you have any questions, just ask on IRC in #rubygems on Freenode or file
  19    an issue here: http://github.com/rubygems/rubygems/issues
  20
  21 For more information and ideas on how to contribute to RubyGems ecosystem, see
  22 here: http://guides.rubygems.org/contributing/
  23
  24 == Getting Started
  25
  26 Run:
  27
  28     $ gem install hoe
  29     $ rake newb
  30
  31 After `rake newb` finishes you can run `rake` to run the tests.
  32
  33 == Issues
  34
  35 RubyGems uses milestones and labels to track issues and pull requests.
  36
  37 A new milestone is created for each feature release.  New features will be
  38 merged (for a pull request) or implemented when "enough" have accumulated.
  39 Upon release the milestone will be closed.  Bug fixes are added to the next
  40 feature release milestone and merged or fixed and released as-needed.  Bug fix
  41 releases use the previous feature release minor version number.
  42
  43 Issues in the "Unfulfilled Promises and Broken Dreams" milestone are looking
  44 for implementors.  It is highly unlikely they will be implemented by RubyGems
  45 committers.  They may be closed after one year.
  46
  47 Issues in the "Future" milestone are more likely to be implemented by RubyGems
  48 committers.  They are triaged with each new feature release and either move to
  49 the new version numbered milestone, left in "Future" or moved to "Unfulfilled
  50 Promises and Broken Dreams".  They may be closed after one year.
  51
  52 Issues with accepted status in a feature release milestone have been reviewed
  53 and triaged and are scheduled for a fix or implementation.
  54
  55 Issues with the feedback status may be closed one week after a request for more
  56 information from a collaborator.  They will be reopened when more information
  57 becomes available.
  58