Added topchannels.
[irssi-scripts.git] / README
blobb1abd77198d47c289ffd362916542180e2130978
1 irssi-scripts is a collection of user-contributed and user-reviewed scripts for
2 irssi. Only scripts under a free software license should be in this repository.
4 This is meant for users who haven't had luck getting any irssi devs reviewing
5 their scripts for scripts.irssi.org which seems to be dead for extensive times.
7 Branches
8 ========
10 master
11   Reviewed scripts, should be safe to use
13 incoming
14   New scripts and updates that have not yet been reviewed, use at your own risk!
16 Reviewing process
17 =================
19 1. New scripts or updates are added to the incoming branch.
20 2. New changes are reviewed by reviewer A:
21    $ git checkout incoming
22    $ git diff master..incoming
23    $ git commit --allow-empty -m 'Reviewed by A' # empty commit is created to denote the review
24 3. New changes are reviewed by reviewer B; now they can be merged to master branch:
25    $ git merge --no-ff incoming
27 Contributing
28 ============
30 If you have scripts to add or want to help reviewing scripts, contact hoxu at chat.freenode.net.