Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 61 lines (38 sloc) 1.887 kb
ab2b670 Joel Larsson Test gem create stuff
authored
1 = README.DEV
2
3 Copyright (C) 2011 Sebastian Wallin, Johan Brissmyr, Johan Gyllenspetz, Joel Larsson <contact@popdevelop.com>
4
5 = HOW TO CONTRIBUTE TO THE skeleton PROJECT?
6
7 There are many possible ways to contribute to the skeleton project,
8 such as:
9
10 * Send a bug report or write a bug fix patch
11 * Add and correct documentation
12 * Develop code for new features, etc.
13
14 All of these are welcome! However, this document describes the last option,
15 how to contribute your code to the skeleton distribution.
16
17 == Git
18
19 skeleton is now under git source control at http://github.com/popdevelop/skeleton.
20 There are two basic ways to contribute: with patches or pull requests.
21
22 = CODING STYLE
23
24 Please follow these guidelines, http://www.caliban.org/ruby/rubyguide.shtml#style
25
26 == Indentation must not include evil tabs
27
28 * Use 2 spaces for indentation.
29
30 == Documentation should be written in the RDoc format in the source code
31
32 The RDoc format is becoming the popular standard for Ruby documentation.
33
34 Additional tutorial documentation and working examples are encouraged
35 with your contribution. You may use the header part of the file for
36 this purpose as demonstrated in the previous section.
37
38 == Standard documentation
39
40 Each file should start with a header, which covers the following topics:
41 * copyright
42 * license
43 * description of the file (_not_ the classes; see below)
44 * any references, if appropriate
45
46 == Testing code should use 'test/unit'
47
48 Unit tests should come with your modules by which you can assure what
49 you meant to do with each method. The test code is useful to make
50 maintenance easy and ensure stability.
51
52 = NAMESPACE
53
54 Your module should be located under the top-level module skeleton and put under
55 the 'skeleton/lib/skeleton' directory. The class/module names and the
56 file names should be short and descriptive.
57
58 = MAINTENANCE
59
60 Finally, please maintain the code you've contributed.
Something went wrong with that request. Please try again.