slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: PULLREQUESTS: guidance on PR titles

Browse Source
This commit is contained in:
Simon Michael 2025-05-29 08:07:55 -10:00
parent 26991b86e9
commit 40d69a8b14
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/PULLREQUESTS.md
View File

@ -54,6 +54,12 @@ Smaller/more focussed PRs can be reviewed quicker and accepted (or rejected) qui
Consider showing a draft of documentation first (more on this below). Consider showing a draft of documentation first (more on this below).
When you are not ready for the PR to be merged, please make it a Draft PR.
Non-draft means "I think this is ready, you can merge any time".
And just use a normal PR title, don't write "WIP:" or "Draft:" there.
This helps with knowing PRs' status in a consistent way.
## The commit(s) ## The commit(s)
Commits should be easy to review. Commits should be easy to review.
@ -86,7 +92,7 @@ Rebase your commits against latest master for easiest review. Especially if they
We like to use some conventions in commit messages when it makes sense. These aren't mandatory, but appreciated: We like to use some conventions in commit messages when it makes sense. These aren't mandatory, but appreciated:
- prepend a [label](ISSUES.md#labels) prefix, eg `cli: ` or `journal: `, for clarity and to help with changelog production - prepend a [topic label](ISSUES.md#labels) prefix, eg `cli: ` or `journal: `, for clarity and to help with changelog production
- prepend a semicolon (`;`) to indicate commits that - prepend a semicolon (`;`) to indicate commits that
- need not trigger a CI workflows, reducing wasteful carbon emissions - need not trigger a CI workflows, reducing wasteful carbon emissions
- and probably need not be mentioned in changelogs/release notes - and probably need not be mentioned in changelogs/release notes