docs: clarify proper PR title format

this is a redo of #9210 because I'm an idiot and can't squash
This commit is contained in:
Gingeropolous 2024-08-24 09:19:29 -04:00 committed by GitHub
parent a1dc85c537
commit 4221051c95
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -43,6 +43,15 @@ Commit messages should be sensible. That means a subject line that
describes the patch, with an optional longer body that gives details, describes the patch, with an optional longer body that gives details,
documentation, etc. documentation, etc.
Please reference the current merged PR list for a general subject line
format of the current contributors. As of 2024 the subject line uses the
following format:
subdirectory under src where changes were made: description of change
For example (PR #9189):
cryptonote_core: early out on out of bounds scaling parameter
When submitting a pull request on GitHub, make sure your branch is When submitting a pull request on GitHub, make sure your branch is
rebased. No merge commits nor stray commits from other people in rebased. No merge commits nor stray commits from other people in
your submitted branch, please. You may be asked to rebase if there your submitted branch, please. You may be asked to rebase if there