Skip to content

Commit 23f3705

Browse files
committed
Added a contributing section to the readme.
1 parent 14fc4bf commit 23f3705

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.textile

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,20 @@ h2. Community
4545
* Join us on IRC "#locomotivecms at irc.freenode.net!":http://webchat.freenode.net/
4646
* "Follow us on twitter":http://twitter.com/locomotiveapp
4747

48+
h2. Contributing to Locomotive
49+
50+
Locomotive CMS is an open source project, we encourage contributions. If you have found a bug and want to contribute a fix, or have a new feature you would like to add, follow the steps below to get your patch into the project:
51+
52+
* Install ruby and mongoDB
53+
* Clone the project <code>git clone [email protected]:locomotivecms/engine.git</code>
54+
* Setup a virtual host entry for <code>test.example.com</code> to point to localhost
55+
* Run the tests <code>rake</code>
56+
* Write your failing tests
57+
* Make the tests pass
58+
* "Create a GitHub pull request":http://help.github.com/send-pull-requests
59+
60+
For new features (especially large ones) it is best to create a topic on the "discussion forums":http://locomotive.vanillaforums.com/ first to make sure it fits into the goals of the project.
61+
4862
h2. Team
4963

5064
* Developers: "Didier Lafforgue":http://www.nocoffee.fr, "Jacques Crocker":http://www.railsjedi.com, "Mario Visic":http://www.mariovisic.com

0 commit comments

Comments
 (0)