diff options
| author | Alexander Færøy | 2014-05-31 14:26:44 +0200 | 
|---|---|---|
| committer | Alexander Færøy | 2014-05-31 14:26:44 +0200 | 
| commit | bef245428d0e2399937a7521b40d077b310e4547 (patch) | |
| tree | 513b97fe0bdd6ee1e22a42ac900e30d4b77098c3 | |
| parent | e9226b4298403d3e8edc78d3bee49d0cb8fbfe4e (diff) | |
| download | scripts.irssi.org-bef245428d0e2399937a7521b40d077b310e4547.tar.bz2 | |
Add contributing guidelines
| -rw-r--r-- | README.markdown | 15 | ||||
| -rw-r--r-- | index.html | 3 | 
2 files changed, 18 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. @@ -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> | 
