aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING')
-rw-r--r--CONTRIBUTING25
1 files changed, 25 insertions, 0 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING
new file mode 100644
index 0000000..0f8dd45
--- /dev/null
+++ b/CONTRIBUTING
@@ -0,0 +1,25 @@
+# -*- mode: org; -*-
+#+STARTUP: showall
+
+If you wish to contribute you can use either the sources located on
+[[http://code.ryuslash.org/cgit.cgi/clark][ryuslash.org]] or the [[http://github.com/ryuslash/clark.git][github]] sources.
+
+* Getting the source
+
+ If you wish to work on CLark you can get the sources by cloning the
+ git repository:
+ #+BEGIN_EXAMPLE
+ git clone git://ryuslash.org/clark.git
+ #+END_EXAMPLE
+
+* Style
+
+ Use spaces, don't use tabs. If you can, keep lines shorter than 80
+ characters. Other than that, Emacs + SLIME can handle indentation
+ pretty well.
+
+* Patches
+
+ If you want to send any patches I prefer the output generated by =git
+ request-pull=, possibly with =-p=, over things like github pull
+ requests.