Use proper commit messages and PR titles
Effective Git commit messages and subject lines hold immense significance in comprehending alterations and enhancing the code's maintainability.
Always commit the changes to your fork and push them to the corresponding original repo by sending a Pull Request (PR). Follow the best practices for writing commit messages/PR titles.
-
Limit the subject line to 50 characters
-
Capitalize the subject line
-
Do not end the subject line with a period
-
Use the imperative mood in the subject line. A properly formed Git commit subject line should always be able to complete the following sentence:
If applied, this commit will
<your subject line here>
Bad commit messages/subject lines
Feature request for banking app - Violting 4th point above and not informative enough
Add minor changes - Not informative enough
Implementing XML to record converter - Violting 4th point above
fix GraalVM compatibility warnings after Java17 migration. - Violting 2nd and 3rd points above
Good commit messages/subject lines
Fix the failure to generate records from xml when multiple namespaces exist
Fix GraalVM compatibility warnings after Java17 migration