summaryrefslogtreecommitdiffstats
path: root/README.markdown
diff options
context:
space:
mode:
authorAlexander Færøy2014-05-31 14:26:44 +0200
committerAlexander Færøy2014-05-31 14:26:44 +0200
commitbef245428d0e2399937a7521b40d077b310e4547 (patch)
tree513b97fe0bdd6ee1e22a42ac900e30d4b77098c3 /README.markdown
parente9226b4298403d3e8edc78d3bee49d0cb8fbfe4e (diff)
downloadscripts.irssi.org-bef245428d0e2399937a7521b40d077b310e4547.tar.bz2
Add contributing guidelines
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown15
1 files changed, 15 insertions, 0 deletions
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.