- Use the imperative mode (e.g, “Fix rendering of user logs”) in commit messages.
- If your patch addresses a JIRA ticket, add the JIRA ticket ID to the commit message.
Improve UI for changing names - Change button color for Auto-fill - Add help text [#OSF-4251]
- If your patch fixes a Github issue, you can add the issue to your commit message so that the issue will automatically be closed when the patch is merged.
Fix bug in loading filetree [fix CenterForOpenScience/osf.io#982]
- Write good commit messages.
Here’s a model message, taken from the above post:
Capitalized, short (50 chars or less) summary More detailed explanatory text, if necessary. Wrap it to about 72 characters or so. In some contexts, the first line is treated as the subject of an email and the rest of the text as the body. The blank line separating the summary from the body is critical (unless you omit the body entirely); tools like rebase can get confused if you run the two together. Write your commit message in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug." This convention matches up with commit messages generated by commands like git merge and git revert. Further paragraphs come after blank lines. - Bullet points are okay, too - Typically a hyphen or asterisk is used for the bullet, followed by a single space, with blank lines in between, but conventions vary here - Use a hanging indent