DEVELOPERS.md (angular.js-1.7.9) | : | DEVELOPERS.md (angular.js-1.8.0) | ||
---|---|---|---|---|
skipping to change at line 248 | skipping to change at line 248 | |||
``` | ``` | |||
<type>(<scope>): <subject> | <type>(<scope>): <subject> | |||
<BLANK LINE> | <BLANK LINE> | |||
<body> | <body> | |||
<BLANK LINE> | <BLANK LINE> | |||
<footer> | <footer> | |||
``` | ``` | |||
The **header** is mandatory and the **scope** of the header is optional. | The **header** is mandatory and the **scope** of the header is optional. | |||
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier | Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier | |||
to read on GitHub as well as in various git tools. | to read on GitHub as well as in various git tools. | |||
### Revert | ### Revert | |||
If the commit reverts a previous commit, it should begin with `revert: `, follow ed by the header | If the commit reverts a previous commit, it should begin with `revert: `, follow ed by the header | |||
of the reverted commit. | of the reverted commit. | |||
In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit | In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit | |||
being reverted. | being reverted. | |||
### Type | ### Type | |||
Must be one of the following: | Must be one of the following: | |||
skipping to change at line 427 | skipping to change at line 427 | |||
#### Code blocks | #### Code blocks | |||
In line code can be specified by enclosing the code in back-ticks (\`). | In line code can be specified by enclosing the code in back-ticks (\`). | |||
A block of multi-line code can be enclosed in triple back-ticks (\`\`\`) but it is formatted better | A block of multi-line code can be enclosed in triple back-ticks (\`\`\`) but it is formatted better | |||
if it is enclosed in <pre>...</pre> tags and the code lines themselv es are indented. | if it is enclosed in <pre>...</pre> tags and the code lines themselv es are indented. | |||
### Writing runnable (live) examples and e2e tests | ### Writing runnable (live) examples and e2e tests | |||
It is possible to embed examples in the documentation along with appropriate e2e tests. These | It is possible to embed examples in the documentation along with appropriate e2e tests. These | |||
examples and scenarios will be converted to runnable code within the documentati on. So it is | examples and scenarios will be converted to runnable code within the documentati on. So it is | |||
important that they work correctly. To ensure this, all these e2e scenarios are run as part of the | important that they work correctly. To ensure this, all these e2e scenarios are run as part of the | |||
automated Travis tests. | continuous integration tests. | |||
If you are adding an example with an e2e test, you should [run the test locally] (#e2e-tests) first | If you are adding an example with an e2e test, you should [run the test locally] (#e2e-tests) first | |||
to ensure it passes. You can change `it(...)` to `fit(...)` to run only your tes t, | to ensure it passes. You can change `it(...)` to `fit(...)` to run only your tes t, | |||
but make sure you change it back to `it(...)` before committing. | but make sure you change it back to `it(...)` before committing. | |||
#### The `<example>` tag | #### The `<example>` tag | |||
This tag identifies a block of HTML that will define a runnable example. It can take the following | This tag identifies a block of HTML that will define a runnable example. It can take the following | |||
attributes: | attributes: | |||
* `animations` - if set to `true` then this example uses ngAnimate. | * `animations` - if set to `true` then this example uses ngAnimate. | |||
End of changes. 2 change blocks. | ||||
2 lines changed or deleted | 2 lines changed or added |