Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 87 lines (64 sloc) 3.669 kB
09d4d7e @cypher Add inital version of the contributing page
cypher authored
1 ---
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
2 title: "Sinatra: Contribute"
09d4d7e @cypher Add inital version of the contributing page
cypher authored
3 layout: default
4 ---
5
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
6 # Contribute
6596022 @cypher more description
cypher authored
7
8 Want to show Sinatra some love? Help out by contributing!
09d4d7e @cypher Add inital version of the contributing page
cypher authored
9
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
10 ## Find a bug?
6596022 @cypher more description
cypher authored
11
8d36f96 @sr lighthouse => github
sr authored
12 Log it in our [issue tracker][ghi] or send a note to
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
13 the [mailing list][ml]. Be sure to include all relevant information, like
14 the versions of Sinatra and Ruby you're using. A [gist](http://gist.github.com/)
15 of the code that caused the issue as well as any error messages are also very
16 helpful.
2b665f8 @cypher Steal^WCopy^WInspired by rtomayko's stuff from lighthouse
cypher authored
17
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
18 ## Need help?
2b665f8 @cypher Steal^WCopy^WInspired by rtomayko's stuff from lighthouse
cypher authored
19
0cc10f1 @rkh update mailinglist subscriber number
rkh authored
20 The [Sinatra mailing list][ml] has over 800 subscribers, many of which are happy
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
21 to help out newbies or talk about potential feature additions. You can also drop
22 by the [#sinatra](irc://chat.freenode.net/#sinatra) channel on
23 [irc.freenode.net](http://freenode.net).
2b665f8 @cypher Steal^WCopy^WInspired by rtomayko's stuff from lighthouse
cypher authored
24
25 ## Have a patch?
26
467fce8 @cypher Reformat contributing to 72 columns
cypher authored
27 Bugs and feature requests that include patches are much more likely to
28 get attention. Here are some guidelines that will help ensure your patch
29 can be applied as quickly as possible:
30
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
31 1. **Use [Git](http://git-scm.com) and [GitHub](http://github.com):**
467fce8 @cypher Reformat contributing to 72 columns
cypher authored
32 The easiest way to get setup is to fork the
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
33 [sinatra/sinatra repo](http://github.com/sinatra/sinatra/).
34 Or, the [sinatra.github.com repo](http://github.com/sinatra/sinatra.github.com/),
35 if the patch is doc related.
467fce8 @cypher Reformat contributing to 72 columns
cypher authored
36
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
37 2. **Write unit tests:** If you add or modify functionality, it must
38 include unit tests. If you don't write tests, we have to, and this
39 can hold up acceptance of the patch.
40
41 3. **Mind the `README`:** If the patch adds or modifies a major feature,
42 modify the `README.rdoc` file to reflect that. Again, if you don't
43 update the `README`, we have to, and this holds up acceptance.
2b665f8 @cypher Steal^WCopy^WInspired by rtomayko's stuff from lighthouse
cypher authored
44
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
45 4. **Push it:** Once you're ready, push your changes to a topic branch
46 and add a note to the ticket with the URL to your branch. Or, say
a0ddc30 @rkh mention pull requests
rkh authored
47 something like, "you can find the patch on johndoe/foobranch". We also
48 gladly accept Github [pull requests](http://help.github.com/pull-requests/).
6596022 @cypher more description
cypher authored
49
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
50 __NOTE:__ _we will take whatever we can get._ If you prefer to
51 attach diffs in emails to the mailing list, that's fine; but do know
52 that _someone_ will need to take the diff through the process described
53 above and this can hold things up considerably.
6596022 @cypher more description
cypher authored
54
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
55 ## Want to write docs?
09d4d7e @cypher Add inital version of the contributing page
cypher authored
56
27c0cac @rkh updated "Want to write docs?"
rkh authored
57 The process for contributing to Sinatra's website, documentation or the book
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
58 is the same as contributing code. We use git for versions control and
27c0cac @rkh updated "Want to write docs?"
rkh authored
59 GitHub to track patch requests.
09d4d7e @cypher Add inital version of the contributing page
cypher authored
60
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
61 * [The sinatra.github.com repo](http://github.com/sinatra/sinatra.github.com/)
62 is where the website sources are managed. There are almost always people in
63 `#sinatra` that are happy to discuss, apply, and publish website patches.
09d4d7e @cypher Add inital version of the contributing page
cypher authored
64
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
65 * [The Book](book.html) has its own [git repository](http://github.com/sinatra/sinatra-book/)
66 and build process but is managed the same as the website and project
67 codebase.
09d4d7e @cypher Add inital version of the contributing page
cypher authored
68
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
69 * [The Introduction](intro.html) is generated from Sinatra's
70 [README file](http://github.com/sinatra/sinatra/blob/master/README.rdoc).
09d4d7e @cypher Add inital version of the contributing page
cypher authored
71
6a8554d @cschneid Minor update to translations paragraph in contributing
cschneid authored
72 * If you want to help translating the documentation, there already is a
27c0cac @rkh updated "Want to write docs?"
rkh authored
73 [Japanese](http://github.com/sinatra/sinatra/blob/master/README.jp.rdoc)
74 and a [German](http://github.com/sinatra/sinatra/blob/master/README.de.rdoc)
6a8554d @cschneid Minor update to translations paragraph in contributing
cschneid authored
75 version of the README, which tend to fall behind the English
76 version. Translations into other languages would also be appreciated.
27c0cac @rkh updated "Want to write docs?"
rkh authored
77
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
78 ## Looking for something to do?
09d4d7e @cypher Add inital version of the contributing page
cypher authored
79
8d36f96 @sr lighthouse => github
sr authored
80 If you'd like to help out but aren't sure how, pick something that looks
81 interesting from the [issues][ghi] list and hack on. Make sure to leave a
82 comment on the ticket noting that you're investigating (a simple "Taking..."
83 is fine).
09d4d7e @cypher Add inital version of the contributing page
cypher authored
84
8d36f96 @sr lighthouse => github
sr authored
85 [ghi]: http://github.com/sinatra/sinatra/issues
2a276d9 @rtomayko ML has over 700 subs now
rtomayko authored
86 [ml]: http://groups.google.com/group/sinatrarb/topics "Sinatra Mailing List"
Something went wrong with that request. Please try again.