aboutsummaryrefslogtreecommitdiff
path: root/thanks-pr-template.example
diff options
context:
space:
mode:
authorKonstantin Ryabitsev <konstantin@linuxfoundation.org>2020-04-10 16:18:17 -0400
committerKonstantin Ryabitsev <konstantin@linuxfoundation.org>2020-04-10 16:18:17 -0400
commit4be04f0af9a22087d0052838e013ef2de1ce2ac3 (patch)
treedd37c34838897afe48fd73c02e44b6b8ab73d599 /thanks-pr-template.example
parent4b693fe7edc1f0d42109291284e3ad822725923e (diff)
downloadb4-4be04f0af9a22087d0052838e013ef2de1ce2ac3.tar.gz
Document b4 ty and add template examples
Still a bit slim on documentation, but this is better than nothing. I need to write a better README file that will introduce maintainers to most useful functionality aspects of b4. Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Diffstat (limited to 'thanks-pr-template.example')
-rw-r--r--thanks-pr-template.example28
1 files changed, 28 insertions, 0 deletions
diff --git a/thanks-pr-template.example b/thanks-pr-template.example
new file mode 100644
index 0000000..4994b29
--- /dev/null
+++ b/thanks-pr-template.example
@@ -0,0 +1,28 @@
+# Lines starting with '#' will be removed
+# You can have two different templates for responding to
+# pull requests and for responding to patch series, though
+# in reality the difference will probably be one word:
+# "merged/pulled" vs. "applied".
+# Keeping it short and sweet is preferred.
+#
+On ${sentdate}, ${fromname} wrote:
+# quote will be limited to 5-6 lines, respecting paragraphs
+${quote}
+
+Merged, thanks!
+
+# for pull requests, the summary is a one-liner with the merge commit,
+# so you probably want to set b4.thanks-commit-url-mask in gitconfig
+# to a value like:
+# [b4]
+# thanks-commit-url-mask = https://git.kernel.org/username/c/%.10s
+#
+# Check this page for info on convenient URL shorteners:
+# https://korg.wiki.kernel.org/userdoc/git-url-shorterners
+${summary}
+
+Best regards,
+--
+# if ~/.signature exists, it will be put here, otherwise
+# the contents will be "user.name <user.email>" from gitconfig
+${signature}