README.md in tutter-sppuppet-0.0.8 vs README.md in tutter-sppuppet-0.0.9
- old
+ new
@@ -1,13 +1,14 @@
# tutter-sppuppet
-This action let non collaborators review
-and merge code without having more then read access to the project.
+This action lets non-collaborators review and merge code without having push access to the project.
+Here's how it works:
+
1. A pull request get submitted
-2. Someone thinks it looks good and adds a _+1_ comment
-3. Another person comment _+1_
+2. Someone reviews it and adds a _+1_ comment
+3. Another person comments _+1_
4. The pull request can be merged by commenting _!merge_ when it has the
desired amount of +1's(configurable, defaults to 1)
A pull request will be blocked if it has a _-1_ comment
@@ -20,9 +21,11 @@
action: 'sppuppet'
action_settings:
plus_ones_required: 3
post_instructions: true
instructions: 'To merge, post 3 +1s and then !merge'
+ generate_reports = true
+ reports_dir = '/var/lib/tutter/reports'
### TODO
* whitelist
* blacklist
* tests