| 1 | # [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage Status][coveralls-image]][coveralls-url]
|
| 2 |
|
| 3 | > [conventional-changelog](https://github.com/ajoslin/conventional-changelog) [jQuery](https://github.com/jquery/jquery) preset
|
| 4 |
|
| 5 | **Issues with the convention itself should be reported on the JQuery issue tracker.**
|
| 6 |
|
| 7 | ## JQuery Convention
|
| 8 |
|
| 9 | Commit messages should describe what changed, and reference the issue number if the commit closes or is associated with a particular issue. Commit messages for all jQuery projects should look like this:
|
| 10 |
|
| 11 | ```
|
| 12 | Component: Short Description
|
| 13 |
|
| 14 | Optional Long Description
|
| 15 |
|
| 16 | Fixes #xxx
|
| 17 | Closes gh-yyy
|
| 18 | Ref #zzz
|
| 19 | ```
|
| 20 |
|
| 21 | Every commit must have a subject (the first line). Everything else is optional.
|
| 22 |
|
| 23 | ### Subject
|
| 24 |
|
| 25 | This is the first line. It consists of a component, like "Event" or "Autocomplete".
|
| 26 |
|
| 27 | ### Long description
|
| 28 |
|
| 29 | There are two line breaks between the subject and the long description. The description can have any length and formatting, like lists.
|
| 30 |
|
| 31 | ### References
|
| 32 |
|
| 33 | References to issues or pull requests go after the long description, each one on their own line.
|
| 34 |
|
| 35 | * Use **Fixes** when the commit fixes an open issue.
|
| 36 |
|
| 37 | * Use **Closes** when the commit closes an open pull request.
|
| 38 |
|
| 39 | * Use **Ref** when referencing an issue or pull request that is already closed or should remain open. Examples include partial fixes and commits that add a test but not a fix.
|
| 40 |
|
| 41 | * Always use "gh-xxx" for GitHub issues and pull requests within the same repository. Use "\[user\]/\[repo\]#xxx" when referencing an issue or pull request in another repository, e.g., "Closes jquery/jquery-ui#175".
|
| 42 |
|
| 43 | Based on https://github.com/jquery/contribute.jquery.org/blob/master/pages/commits-and-pull-requests.md#commit-guidelines
|
| 44 |
|
| 45 | [npm-image]: https://badge.fury.io/js/conventional-changelog-jquery.svg
|
| 46 | [npm-url]: https://npmjs.org/package/conventional-changelog-jquery
|
| 47 | [travis-image]: https://travis-ci.org/conventional-changelog/conventional-changelog-jquery.svg?branch=master
|
| 48 | [travis-url]: https://travis-ci.org/conventional-changelog/conventional-changelog-jquery
|
| 49 | [daviddm-image]: https://david-dm.org/conventional-changelog/conventional-changelog-jquery.svg?theme=shields.io
|
| 50 | [daviddm-url]: https://david-dm.org/conventional-changelog/conventional-changelog-jquery
|
| 51 | [coveralls-image]: https://coveralls.io/repos/conventional-changelog/conventional-changelog-jquery/badge.svg
|
| 52 | [coveralls-url]: https://coveralls.io/r/conventional-changelog/conventional-changelog-jquery
|