aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTeddy Wing2018-04-20 20:43:31 +0200
committerTeddy Wing2018-04-20 20:43:31 +0200
commite9009d60966b403dc777f8778e039c7362dfd823 (patch)
treeac4c81864a0f67323e763df9602edc022ee41949 /README.md
parent1e1e840df242874350195635dda63e251f6ddccb (diff)
downloadredprine-master.tar.bz2
README: Add a note about branch name Redmine IDsHEADv0.0.1master
Specify that Git branch names must be prefixed with a four-digit Redmine issue number.
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8be3fd8..9f1dd98 100644
--- a/README.md
+++ b/README.md
@@ -45,6 +45,9 @@ executed with `bash -c`). A single argument is passed in `$0` containing the URL
of the issue’s pull request. The format must match Redmine’s JSON parameter for
the [issue update API endpoint][3].
+Pull request branches are assumed to start with a four-digit number followed by
+a hyphen (e.g. `1234-`), where the number is a Redmine issue ID.
+
## Install
Requirements: