Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 81 lines (59 sloc) 3.292 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
2a276d9 @rtomayko ML has over 700 subs now
rtomayko authored
20 The [Sinatra mailing list][ml] has over 700 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
47 something like, "you can find the patch on johndoe/foobranch".
6596022 @cypher more description
cypher authored
48
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
49 __NOTE:__ _we will take whatever we can get._ If you prefer to
50 attach diffs in emails to the mailing list, that's fine; but do know
51 that _someone_ will need to take the diff through the process described
52 above and this can hold things up considerably.
6596022 @cypher more description
cypher authored
53
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
54 ## Want to write docs?
09d4d7e @cypher Add inital version of the contributing page
cypher authored
55
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
56 The process for contributing to Sinatra's website or documentation
57 is the same as contributing code. We use git for versions control and
58 lighthouse to track patch requests.
09d4d7e @cypher Add inital version of the contributing page
cypher authored
59
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
60 * [The sinatra.github.com repo](http://github.com/sinatra/sinatra.github.com/)
61 is where the website sources are managed. There are almost always people in
62 `#sinatra` that are happy to discuss, apply, and publish website patches.
09d4d7e @cypher Add inital version of the contributing page
cypher authored
63
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
64 * [The Book](book.html) has its own [git repository](http://github.com/sinatra/sinatra-book/)
65 and build process but is managed the same as the website and project
66 codebase.
09d4d7e @cypher Add inital version of the contributing page
cypher authored
67
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
68 * [The Introduction](intro.html) is generated from Sinatra's
69 [README file](http://github.com/sinatra/sinatra/blob/master/README.rdoc).
09d4d7e @cypher Add inital version of the contributing page
cypher authored
70
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
71 ## Looking for something to do?
09d4d7e @cypher Add inital version of the contributing page
cypher authored
72
8d36f96 @sr lighthouse => github
sr authored
73 If you'd like to help out but aren't sure how, pick something that looks
74 interesting from the [issues][ghi] list and hack on. Make sure to leave a
75 comment on the ticket noting that you're investigating (a simple "Taking..."
76 is fine).
09d4d7e @cypher Add inital version of the contributing page
cypher authored
77
252b04f @rtomayko Tidy up contributing page a bit [#107]
rtomayko authored
78 [hp]: http://sinatra.lighthouseapp.com/projects/9779-sinatra/tickets/bins/13046
8d36f96 @sr lighthouse => github
sr authored
79 [ghi]: http://github.com/sinatra/sinatra/issues
2a276d9 @rtomayko ML has over 700 subs now
rtomayko authored
80 [ml]: http://groups.google.com/group/sinatrarb/topics "Sinatra Mailing List"
Something went wrong with that request. Please try again.