Skip to content
Newer
Older
100644 51 lines (38 sloc) 1.87 KB
6f27760 @myabc Convert datamapper.org site to Jekyll, Markdown
myabc authored
1 ---
2 layout: default
3 title: Contribute to DataMapper
4 created_at: Wed Aug 29 20:37:00 +0930 2007
5 ---
6
7 {{page.title}}
8 ==============
9
10 DataMapper is always looking for more contributors. When you've got an itch to
11 scratch, jump in and contribute! Write a few specs showing us how your code
3fe97f2 @postmodern Link to http://github.com/datamapper/
postmodern authored
12 works, create a patch and [submit it](http://github.com/datamapper/)
13 as a new ticket or a fix for an existing one. After a few patches and many
14 thanks, you'll get commit access.
6f27760 @myabc Convert datamapper.org site to Jekyll, Markdown
myabc authored
15
16 We benchmark all but the most trivial of patches, because we care about
17 performance and you should too!
18
19 What we need
20 ------------
21
22 Currently DataMapper needs help in a few particular areas:
23
9098c9e @dkubb Fixed broken links in docs
dkubb authored
24 * API Documentation (using the [YARD documentation style](http://www.yardoc.org/))
60eb46c @postmodern Try to keep things within 80 columns.
postmodern authored
25 * Tutorials (we think the [Django](http://www.djangoproject.com/)
26 documentation [guidelines](http://jacobian.org/writing/great-documentation/) are a good model)
27 * Bug Reports (we use [Github Issues](https://github.com/datamapper/dm-core/issues/))
6d721d8 @postmodern Link to http://github.com/datamapper/dm-core.
postmodern authored
28 * **Important**: if you found a bug in a DataMapper project other than
29 [dm-core](http://github.com/datamapper/dm-core), please use that
30 project's Issue Tracker instead of reporting everything as dm-core
31 issues
6f27760 @myabc Convert datamapper.org site to Jekyll, Markdown
myabc authored
32
33 Git - Edge DataMapper
34 ---------------------
35
60eb46c @postmodern Try to keep things within 80 columns.
postmodern authored
36 DataMapper development uses [Git](http://git-scm.com/) SCM.
d44ea85 @postmodern Append .html to links.
postmodern authored
37 Please see [using git](/using-git.html) to learn how to contribute.
60eb46c @postmodern Try to keep things within 80 columns.
postmodern authored
38 For detailed instructions how to get a proper development setup for
39 datamapper up and running, have a look at the [edge guide](http://github.com/datamapper/dm-dev).
6f27760 @myabc Convert datamapper.org site to Jekyll, Markdown
myabc authored
40
41 Code Style Guidelines
42 ---------------------
43
00c484a @dkubb Minor punctuation updates
dkubb authored
44 When contributing any code to DataMapper, please follow these guidelines:
6f27760 @myabc Convert datamapper.org site to Jekyll, Markdown
myabc authored
45
00c484a @dkubb Minor punctuation updates
dkubb authored
46 1. Code should match the [style guide](http://github.com/dkubb/styleguide)
093fc76 @dkubb Linked to the style guide and updated contribution guidelines
dkubb authored
47 2. Specs are required
9098c9e @dkubb Fixed broken links in docs
dkubb authored
48 3. Documentation is required (use the [YARD documentation style](http://www.yardoc.org/))
d18ab91 @myabc Update YARD links, RSpec not Rspec, minor fixes
myabc authored
49
50 *[YARD]: Yet Another Ruby Documentation (tool)
Something went wrong with that request. Please try again.