Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/twbs/no-carrier.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Rebert <github@rebertia.com>2015-04-25 11:10:38 +0300
committerChris Rebert <github@rebertia.com>2015-04-25 11:10:38 +0300
commitea278f282cebd446537ff3eac55c39d587c27289 (patch)
treea7c7cc5ba54e1faab2a2d3df4f4f0b6b9157bfb0 /README.md
parent934890c26310ee0a6443bf2b43d8eca24c17640d (diff)
README: finish Motivation and Usage sections
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7290b8d..138277f 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,13 @@ NO CARRIER is a tool to auto-close old GitHub issues that were waiting for a res
Named after [the message indicating that your dial-up modem has lost its connection.](http://en.wikipedia.org/wiki/NO_CARRIER#As_Internet_slang)
## Motivation
+You're a member of a popular open source project. Cool.
+But due to the project's popularity, you get lots of bug reports on the issue tracker, and often these reports are lacking key information that's explicitly mentioned in your CONTRIBUTING docs as being required. Or maybe you just need extra information or test results from the bug reporter. So, okay, you post nice reply comments on the issues, asking the reporters for the information or requesting that they do some investigation/tests.
+
+And then you wait for a reply. Unfortunately, for whatever reason, a surprisingly large fraction of folks never end up replying to your questions/requests. So unactionable issues start to pile up. You occasionally review the oldest batch of such issues and close them manually.
+
+By automating the process of closing abandoned issues, the issue tracker is kept clean with less tedium on the part of issue triagers. The abandoned issue expiration policy is also applied more uniformly/fairly, and it's easier to use a canonical template for the closing issue comment that clearly and politely explains the reason for the closure.
## Used by
* (Hopefully Bootstrap real soon)
@@ -15,7 +21,12 @@ Named after [the message indicating that your dial-up modem has lost its connect
## Usage
Java 8+ is required to run NO CARRIER. For instructions on building NO CARRIER yourself, see [the Contributing docs](https://github.com/cvrebert/no-carrier/blob/master/CONTRIBUTING.md).
-NO CARRIER accepts command line arguments (XXX). Once you've built the JAR, run e.g. `java -jar no-carrier-assembly-1.0.jar XXX`.
+NO CARRIER accepts exactly 5 command line arguments. Once you've built the JAR, run e.g. `java -jar no-carrier-assembly-1.0.jar <username> <password> <owner/repo> <label> <days>`. Here's what each of the arguments is:
+* `username`: Username of GitHub user to login as
+* `password`: Password of GitHub user to login as
+* `owner/repo`: GitHub repo whose issues will be operated upon (example: `twbs/bootstrap` for [Bootstrap](https://github.com/twbs/bootstrap))
+* `label`: Name of label used on the repo's GitHub issue tracker to indicate that the issue is blocked waiting for a reply from a user (typically the issue's original poster).
+* `days`: Integer number of days. If at least this number of days elapses after an issue has been labeled without any new comment being posted, NO CARRIER will close the issue and post an explanatory comment.
## Acknowledgments
We all stand on the shoulders of giants and get by with a little help from our friends. NO CARRIER is written in [Scala](http://www.scala-lang.org) and built on top of: