-
Notifications
You must be signed in to change notification settings - Fork 81
Commit Log Guidelines
We have some rules to writting commit messages. It makes easy to read message and easy to follow when looking throught the project history. As well, we use it to generate the change log.
Commit message consists of a header, a body and a footer. The subject has a special format that includes a type, a module and a subject:
<type>(<module>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
Must be one of the following:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code. Such as white-space, formatting, missing semi-colons, etc... It also possible to change JSHint, JSCS rules of the code.
- refactor: A code change that neither fixes a bug nor adds a feature
- test: Adding missing tests. Changing tests.
- demo: Adding missing demos. Changing demos.
- chore: Changes to the build process or tools and libraries such as documentation generation
The moudle could be specifying source files of the commit change. For example consts, LayoutManager, Axes, AnimationManager, InfiniteGrid, ImageLoaded, ...
The subject contains compact description of the change.
The body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any reference about Breaking Changes. Mostly, it could be GitHub issues that related with the change.
reference should start with the word Ref. If it is GitHub issue reference, It should be GitHub issue number with #.
Ref #123 //reference of GitHub issue
Ref http://forum.jquery.com/topic/jquery-v1-11-3-memory-leak //external reference
fix(AnimationManager): update aborting animation logic
Abort the animating post process when "tap" occurs or velocity is zero at inside border.
Ref #30
refactor(InfiniteGrid): separates eventHandler
Separate eventHandler from infiniteGrid.
Ref #108
test(InputObserver, PanInput): event test for tap gesture
Ref #30
style(Coordinate): changed some code styles
Removed unnecessary parentheses
Assigning array value using concat instead of each
Removed unnecessary string concatenation