;dev: pr template: mention COMMITS page and prefix convention (#1997)
This commit is contained in:
parent
1e1b26261d
commit
679f62cc60
15
.github/pull_request_template.md
vendored
15
.github/pull_request_template.md
vendored
@ -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,
|
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.
|
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,
|
To minimise waste, and get your hledger PRs accepted quickly,
|
||||||
please check the latest guidelines in the developer docs:
|
please check the guidelines in the developer docs:
|
||||||
|
|
||||||
https://hledger.org/PULLREQUESTS.html
|
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
|
||||||
|
|
||||||
-->
|
-->
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user