Skip to content

Commit e8ae9ba

Browse files
docs(chore): document git commit conventions
To introduce contributors to our git conventions, our CONTRIBUTING.md file now links to the AngularJS contributing document.
1 parent 44c9088 commit e8ae9ba

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,28 @@ $ npm run cover
5757

5858
The test coverage report will be available in `coverage/`.
5959

60+
## Commit Guidelines
61+
62+
We follow the AngularJS [commit conventions](ngcontributing). Please model your commit message after the following structure:
63+
64+
```
65+
<type>(<scope>): <subject>
66+
<BLANK LINE>
67+
<body>
68+
<BLANK LINE>
69+
<footer>
70+
```
71+
72+
- All lines must be limited to 72 characters
73+
- For `<scope>`, you may use:
74+
- `app` for an application-wide change
75+
- `datastore`
76+
- `pubsub`
77+
- `storage`
78+
- etc.
79+
80+
Be sure to read the AngularJS [contributing document][commitstandard]. For a thorough explanation, see the [AngularJS Git Commit Message Conventions doc][commitdoc].
81+
6082
## Contributor License Agreements
6183

6284
Before we can accept your pull requests you'll need to sign a Contributor License Agreement (CLA):
@@ -70,3 +92,5 @@ You can sign these electronically (just scroll to the bottom). After that, we'll
7092
[gcloudcli]: https://developers.google.com/cloud/sdk/gcloud/
7193
[indvcla]: https://developers.google.com/open-source/cla/individual
7294
[corpcla]: https://developers.google.com/open-source/cla/corporate
95+
[ngcontributing]: https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format
96+
[commitdoc]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#

0 commit comments

Comments
 (0)