From: Alexander Færøy <redacted>
Date: Sat, 31 May 2014 12:26:44 +0000 (+0200)
Subject: Add contributing guidelines
X-Git-Url: http://git.99rst.org/?a=commitdiff_plain;h=bef245428d0e2399937a7521b40d077b310e4547;p=irssi-scripts.irssi.org.git

Add contributing guidelines
---

diff --git a/README.markdown b/README.markdown
index 5bc1174..2785b50 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1 +1,16 @@
 ## Irssi's Script Repository
+
+This repository contains scripts available at
+[scripts.irssi.org](http://scripts.irssi.org).
+
+### Contributing
+
+To add or modify a script do the following:
+
+1. Fork this repository on Github.
+2. Create a feature branch for your set of patches using `git checkout -b foobar`.
+3. Add or modify your script in the repository. Remember to add it to Git using `git add`.
+4. If you are adding a new script, remember to add script information in `_data/scripts.yaml`. This file is sorted by script filename.
+5. Commit your changes to Git and push them to Github.
+6. Submit pull request.
+7. Await review of your changes by one of our developers.
diff --git a/index.html b/index.html
index 6b80b66..0a7f2bc 100644
--- a/index.html
+++ b/index.html
@@ -35,6 +35,9 @@ layout: default
             <code>~/.irssi/scripts/</code> and created symlinks to autorun
             directory (eg. <code>cd ~/.irssi/scripts/autorun/ ; ln -s
                 ../script.pl .</code>)</dd>
+
+            <dt>How do I submit a script to this page?</dt>
+            <dd>See information on how to contribute <a href="https://github.com/irssi/scripts">here</a>.</dd>
         </dl>
 
         <hr>