-
-
Notifications
You must be signed in to change notification settings - Fork 353
Committing Your Code
Your commit messages are the foundation for release notes and for the documentation team. You can help by following these guidelines when committing your changes:
-
Use English Use past-tense and write as if the end user admin was reading them. For example, use ‘Updated’, ‘Added’, ‘Fixed’ instead of ‘Update’, ‘Add’, ‘Fix’.
BAD
+ Add a migration
GOOD
+ Added new View Serving Teams page to manage serving groups.
Remember to include a period at the end of your sentence.
- Asterisk or Plus If your change needs to be in release notes, append an asterisk (*) or plus (+) to the beginning of the message. Example:
+ Added vital new instructions for the administrator checklist on the Rock home page.
- Minus If your change is of almost no importance, prefix it with a minus (-). Example:
- Removed incorrect code comments from the Foo block.
-
... (Fixes #000). If your change is for a fix, write
(Fixes #000).at the end of the sentence. Example:
+ Fixed issue where communications were not being sent (Fixes #375).
-
[doc] or [devdoc] If your change needs to be documented in the user or developer docs, use the tag
[doc]or[devdoc]in the message. Examples:
+ [doc] Added a small group locator block for use on a public website to locate groups by address.
+ [devdoc] Block developers should now use the [Description] attribute on all blocks.
-
[update-NAME] If your change is for one of the external exe apps, use the
[update-FOO]syntax so that the PackageBuilder app will know that it needs to inform the user that the NAME app has changed and needs to be updated also.
+ [update-Check Scanner] Made the Check Scanner application 30% more awesome.
-
Rockineese Keep in mind that the audience reading these may not have intimate knowledge of the inner workings of Rock.
BAD
+ Added sproc ISecured implementation to the base Rock.Data.Model class.
GOOD
+ Added new technique for developers to make it easier to run database stored procedures.
The readme generator doesn't really parse a commit for multiple items, so if you have some lines starting with plus and others with minus, it’s just going to use whatever the entire commit had. If you can, try breaking these up into multiple commits.
"I'm just as guilty of these as anyone, but if we all try to be consistent, it will make it a bit easier to package the updates."
-- the Package Manager
Be kind to the package builder. Look at all these edits he had to make during a recent package build. :(