From 679f62cc60ac7386237c6a7f2c129581b59f5823 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Wed, 1 Feb 2023 13:17:21 -1000 Subject: [PATCH] ;dev: pr template: mention COMMITS page and prefix convention (#1997) --- .github/pull_request_template.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f724151e3..5353f6789 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,8 +4,19 @@ If you're a new developer, FOSS contributor, or hledger contributor, welcome. Much of our best design work and knowledge sharing happens during code review, so be prepared for more work ahead, especially if your PR is large. -To minimise waste, and learn how to get hledger PRs accepted swiftly, -please check the latest guidelines in the developer docs: +To minimise waste, and get your hledger PRs accepted quickly, +please check the guidelines in the developer docs: https://hledger.org/PULLREQUESTS.html +https://hledger.org/COMMITS.html + +You don't need to master our commit conventions, but do add at least one prefix and colon +to the commit message summary. The most common prefixes are: + +- feat: for user-visible features +- fix: for user-visible fixes +- imp: for user-visible improvements +- ;doc: for documentation improvements (; at the start enables quicker/cheaper CI tests) +- dev: for internal improvements + -->