Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 268 lines (208 sloc) 10.415 kB
1643b30 @zenspider wiring the page in
zenspider authored
1 ---
2 layout: default
3 title: Contributing to RubyGems
4 previous: /resources
5 next: /faqs
6 ---
7
dffa3b8 @ffmike Roll in content from soon-to-be-obsolete contribute repo
ffmike authored
8 Looking to contribute to a RubyGems project? You've come to the right place!
9 There are many development efforts going on right now, and they could use
10 your help. Just follow the links below to get started contributing or to contact the
11 project maintainers.
23f76a7 @zenspider Added contributing page
zenspider authored
12
dffa3b8 @ffmike Roll in content from soon-to-be-obsolete contribute repo
ffmike authored
13 ## Core Projects
23f76a7 @zenspider Added contributing page
zenspider authored
14
dffa3b8 @ffmike Roll in content from soon-to-be-obsolete contribute repo
ffmike authored
15 These projects are under the wing of the core [RubyGems team](https://github.com/rubygems/).
23f76a7 @zenspider Added contributing page
zenspider authored
16
dffa3b8 @ffmike Roll in content from soon-to-be-obsolete contribute repo
ffmike authored
17 ### [RubyGems](https://github.com/rubygems/rubygems)
18
19 Ruby's premier packaging system. Bundled with Ruby 1.9+ and available for Ruby 1.8. Any time you run
20 `gem` at the command line, you're using this project.
21
22 [contributors](http://it.isagit.com/rubygems/rubygems) -
23 [issues](http://github.com/rubygems/rubygems/issues) -
24 [mailing list](http://rubyforge.org/mailman/listinfo/rubygems-developers)
25
26 <p class="avatars">
27 <a href="http://github.com/drbrain">
28 <img src="https://secure.gravatar.com/avatar/58479f76374a3ba3c69b9804163f39f4?s=32" title="Eric Hodel">
29 </a>
30 <a href="http://github.com/zenspider">
31 <img src="https://secure.gravatar.com/avatar/16c4b19d8670085a428787f8b2438223?s=32" title="Ryan Davis">
32 </a>
33 <a href="http://github.com/jbarnette">
34 <img src="https://secure.gravatar.com/avatar/c237cf537a06b60921c97804679e3b15?s=32" title="John Barnette">
35 </a>
36 <a href="http://github.com/evanphx">
37 <img src="https://secure.gravatar.com/avatar/540cb3b3712ffe045113cb03bab616a2?s=32" title="Evan Phoenix">
38 </a>
39 </p>
40
41 *Code Guidelines*
23f76a7 @zenspider Added contributing page
zenspider authored
42 + New features should be coupled with tests.
dffa3b8 @ffmike Roll in content from soon-to-be-obsolete contribute repo
ffmike authored
43 + Ensure that your code blends well with ours (eg, no trailing whitespace, match indentation and coding style).
23f76a7 @zenspider Added contributing page
zenspider authored
44 + Don't modify the history file or version number.
dffa3b8 @ffmike Roll in content from soon-to-be-obsolete contribute repo
ffmike authored
45 + If you have any questions, just ask us on IRC in #rubygems or file [an issue][1].
23f76a7 @zenspider Added contributing page
zenspider authored
46
47 [0]: http://github.com/rubygems/rubygems
48 [1]: http://github.com/rubygems/rubygems/issues
dffa3b8 @ffmike Roll in content from soon-to-be-obsolete contribute repo
ffmike authored
49 [2]: http://help.rubygems.org
50
51 ### [RubyGems.org](https://github.com/rubygems/rubygems.org)
52
53 The Ruby community's gem hosting service. Provides a better API for accessing,
54 deploying, and managing gems along with clear and accessible project pages.
55
56 [site](http://rubygems.org) -
57 [contributors](http://it.isagit.com/rubygems/rubygems.org) -
58 [issues](http://github.com/rubygems/rubygems.org/issues) -
59 [mailing list](https://groups.google.com/forum/#!forum/gemcutter)
60
61 <p class="avatars">
62 <a href="http://github.com/qrush">
63 <img src="https://secure.gravatar.com/avatar/eb8975af8e49e19e3dd6b6b84a542e26?s=32" title="Nick Quaranto">
64 </a>
65 <a href="http://github.com/sferik">
66 <img src="https://secure.gravatar.com/avatar/1f74b13f1e5c6c69cb5d7fbaabb1e2cb?s=32" title="Erik Michaels-Ober">
67 </a>
68 <a href="http://github.com/cldwalker">
69 <img src="https://secure.gravatar.com/avatar/8f0660cdc9f5d91c7d97456f8f0be8c7?s=32" title="Gabriel Horner">
70 </a>
71 <a href="http://github.com/cmeiklejohn">
72 <img src="https://secure.gravatar.com/avatar/3e09fee7b359be847ed5fa48f524a3d3?s=32" title="Christopher Meiklejohn">
73 </a>
74 </p>
75
76 ### [RubyGems Guides](https://github.com/rubygems/guides)
77
78 The central home for RubyGems documentation, including tutorials and reference material.
79 User-contributed guides are more than welcome and encouraged!
80
81 [site](http://guides.rubygems.org) -
82 [contributors](http://it.isagit.com/rubygems/guides) -
83 [issues](http://github.com/rubygems/guides/issues)
84
85 <p class="avatars">
86 <a href="http://github.com/qrush">
87 <img src="https://secure.gravatar.com/avatar/eb8975af8e49e19e3dd6b6b84a542e26?s=32" title="Nick Quaranto">
88 </a>
89 <a href="http://github.com/sandal">
90 <img src="https://secure.gravatar.com/avatar/31e038e4e9330f6c75ccfd1fca8010ee?s=32" title="Gregory Brown">
91 </a>
92 <a href="http://github.com/ffmike">
93 <img src="https://secure.gravatar.com/avatar/a54251b745d59735ea5e9f0656a5d58d?s=32" title="Mike Gunderloy">
94 </a>
95 </p>
96
97 ### [RubyGems Testers](https://github.com/rubygems/rubygems-test)
98
99 A community effort to document the test results for various gems,
100 on various machine architectures.
101
102 [site](http://test.rubygems.org/) -
103 [contributors](http://it.isagit.com/rubygems/rubygems-test) -
104 [issues](https://github.com/rubygems/rubygems-test/issues)
105
106 <p class="avatars">
107 <a href="http://github.com/bluepojo">
108 <img src="https://secure.gravatar.com/avatar/4b1e87301a43b027903617a98d61831a?s=32" title="Josiah Kiehl">
109 </a>
110 <a href="http://github.com/erikh">
111 <img src="https://secure.gravatar.com/avatar/1b641a79b2717f2d582ad455b40d5b89?s=32" title="Erik Hollensbe">
112 </a>
113 </p>
114
115 ### [Gem Whisperer](https://github.com/rubygems/gemwhisperer)
116
117 An example of how to use [RubyGems.org's
118 webhooks](http://guides.rubygems.org/rubygems-org-api/#webhook) to listen to every gem being
119 pushed. Currently powers [m.rubygems.org](http://m.rubygems.org) and
120 [@rubygems](http://twitter.com/rubygems).
121
122 [site](http://m.rubygems.org/) -
123 [contributors](http://it.isagit.com/rubygems/gemwhisperer) -
124 [issues](https://github.com/rubygems/gemwhisperer/issues)
125
126 <p class="avatars">
127 <a href="http://github.com/qrush">
128 <img src="https://secure.gravatar.com/avatar/eb8975af8e49e19e3dd6b6b84a542e26?s=32" title="Nick Quaranto">
129 </a>
130 <a href="http://github.com/laserlemon">
131 <img src="https://secure.gravatar.com/avatar/0887991a8846577a6aa85433d6ab3ea2?s=32" title="Steve Richert">
132 </a>
133 </p>
134
135 ### [RubyGems.org API Library](https://github.com/rubygems/gems)
136
137 A Ruby implementation of the various API endpoints available on RubyGems.org.
138 If you're writing a service in Ruby to interact with gems available to the
139 community, check this out!
140
141 [contributors](http://it.isagit.com/rubygems/gems) -
142 [issues](https://github.com/rubygems/gems/issues)
143
144 <p class="avatars">
145 <a href="http://github.com/sferik">
146 <img src="https://secure.gravatar.com/avatar/1f74b13f1e5c6c69cb5d7fbaabb1e2cb?s=32" title="Erik Michaels-Ober">
147 </a>
148 </p>
149
150 ### [RubyGems Search](https://github.com/rubygems/search)
151
152 A souped-up implementation of search on RubyGems.org, using Solr. Still not
153 100% done yet, but hopefully will replace the search box on RubyGems.org soon!
154
155 [contributors](http://it.isagit.com/rubygems/search) -
156 [issues](https://github.com/rubygems/search/issues)
157
158 <p class="avatars">
159 <a href="http://github.com/nz">
160 <img src="https://secure.gravatar.com/avatar/5198f305281b34927f936ba77cffcbf6?s=32" title="Nick Zadrozny">
161 </a>
162 </p>
163
164 ### [RubyGems Mirror](https://github.com/rubygems/rubygems-mirror/wiki/Mirroring-2.0)
165
166 The current state of mirroring RubyGems is frankly embarrassing. We need
167 RubyGems to be highly available all over the world, no more excuses! Discussion
168 is going on in the [rubygems-mirror
169 wiki](https://github.com/rubygems/rubygems-mirror/wiki/Mirroring-2.0) on how
170 to improve it.
171
172 [contributors](http://it.isagit.com/rubygems/rubygems-mirror) -
173 [issues](https://github.com/rubygems/rubygems-mirror/issues)
174
175 <p class="avatars">
176 <a href="http://github.com/raggi">
177 <img src="https://secure.gravatar.com/avatar/b19b02a49b433c9e2e6e6c43785d2bfb?s=32" title="James Tucker">
178 </a>
179 </p>
180
181 ## Ecosystem Projects
182
183 These projects are outside of the RubyGems core, but work closely with RubyGems to improve the gem experience for everyone.
184
185 ### [Bundler](https://github.com/carlhuda/bundler)
186
187 Bundler manages an application's dependencies through its entire life across
188 many machines systematically and repeatably.
189
190 [site](http://gembundler.com/) -
191 [contributors](http://it.isagit.com/carlhuda/bundler) -
192 [issues](https://github.com/carlhuda/bundler/issues) -
193 [mailing list](https://groups.google.com/forum/#!forum/ruby-bundler)
194
195 <p class="avatars">
196 <a href="http://github.com/indirect">
197 <img src="https://secure.gravatar.com/avatar/fb389f1e8b98d5d03be29e9dd309b3be?s=32" title="Andre Arko">
198 </a>
199 <a href="http://github.com/hone">
200 <img src="https://secure.gravatar.com/avatar/efb7c66871043330ce1310a9bdd0aaf6?s=32" title="Terence Lee">
201 </a>
202 <a href="http://github.com/wycats">
203 <img src="https://secure.gravatar.com/avatar/428167a3ec72235ba971162924492609?s=32" title="Yehuda Katz">
204 </a>
205 <a href="http://github.com/carllerche">
206 <img src="https://secure.gravatar.com/avatar/da5274b27cc6c0f505495bf5d504575d?s=32" title="Carl Lerche">
207 </a>
208 </p>
209
210 ### [RubyDoc.info](https://github.com/lsegal/rubydoc.info)
211
212 A fantastic provider of [YARD](http://yardoc.org) documentation for every
213 RubyGem available. Push a gem, and you get docs created instantly!
214 RubyGems.org links to this site and it uses [RubyGems.org's
215 webhooks](http://guides.rubygems.org/rubygems-org-api/#webhook) as well.
216
217 [site](http://rubydoc.info) -
218 [contributors](http://it.isagit.com/lsegal/rubydoc.info) -
219 [issues](https://github.com/lsegal/rubydoc.info/issues) -
220 [mailing list](https://groups.google.com/forum/#!forum/yardoc)
221
222 <p class="avatars">
223 <a href="http://github.com/indirect">
224 <img src="https://secure.gravatar.com/avatar/fb389f1e8b98d5d03be29e9dd309b3be?s=32" title="Andre Arko">
225 </a>
226 <a href="http://github.com/hone">
227 <img src="https://secure.gravatar.com/avatar/efb7c66871043330ce1310a9bdd0aaf6?s=32" title="Terence Lee">
228 </a>
229 </p>
230
231 ### [Stickler](https://github.com/copiousfreetime/stickler)
232
233 Stickler is a great way to run and organize an internal gem server in your
234 organization. It helps with mirroring gems and providing a gem source to add
235 internal or proprietary code to.
236
237 [contributors](http://it.isagit.com/copiousfreetime/stickler) -
238 [issues](https://github.com/copiousfreetime/stickler/issues)
239
240 <p class="avatars">
241 <a href="http://github.com/copiousfreetime">
242 <img src="https://secure.gravatar.com/avatar/cff2d90ae70bbbb5d4865d8412159f85?s=32" title="Jeremy Hinegardner">
243 </a>
244 </p>
245
246 ### [Geminabox](https://github.com/cwninja/geminabox)
247
4f31dda @ffmike Standardize capitalization to 'RubyGems'
ffmike authored
248 Need simple RubyGems hosting? Geminabox can do that! This project provides an
dffa3b8 @ffmike Roll in content from soon-to-be-obsolete contribute repo
ffmike authored
249 easy to setup way to host RubyGems internally and allow uploading of gems
250 without much hassle.
251
252 [contributors](http://it.isagit.com/cwninja/geminabox) -
253 [issues](https://github.com/cwninja/geminabox/issues)
254
255 <p class="avatars">
256 <a href="http://github.com/cwninja">
257 <img src="https://secure.gravatar.com/avatar/f61c5838432c656ea88dd77a56a40f52?s=32" title="Tom Leal">
258 </a>
259 </p>
260
261 ## Your idea?
262
263 We'd love for your new idea to be on this list. If you're working on a
264 RubyGems related project, just [fork this
265 repo](http://github.com/rubygems/guides) and add the link!
266
267
Something went wrong with that request. Please try again.