Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Add markdown doc on how to contribute to Zotonic.

  • Loading branch information...
commit fe25b382b9cc2e08d87e5d9583f95ca071614ad5 1 parent 5366401
@arjan arjan authored
Showing with 30 additions and 0 deletions.
  1. +30 −0 doc/contributing.md
View
30 doc/contributing.md
@@ -0,0 +1,30 @@
+Contributing to Zotonic
+=======================
+
+We encourage contributions to Zotonic from the community!
+
+1. Fork the `zotonic` repository on [[https://github.com/zotonic/zotonic][Github]].
+2. Clone your fork or add the remote if you already have a clone of
+ the repository:
+
+ `git clone git@github.com:yourusername/zotonic.git`
+
+ or
+
+ `git remote add mine git@github.com:yourusername/zotonic.git`
+
+3. Create a topic branch for your change.
+
+ `git checkout -b some-topic-branch`
+
+4.Make your change and commit. Use a clear and descriptive commit
+message, spanning multiple lines if detailed explanation is
+needed.
+
+5. Push to your fork of the repository and then send a pull-request
+ through Github.
+
+ `git push mine some-topic-branch`
+
+6. A Zotonic committer will review your patch and merge it into the
+ main repository or send you feedback.
Please sign in to comment.
Something went wrong with that request. Please try again.