Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(contributing): document git commit conventions #224

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,28 @@ $ npm run cover

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

## Commit Guidelines

We follow the AngularJS [commit conventions][ngcontributing]. Please model your commit message after the following structure:

This comment was marked as spam.

This comment was marked as spam.


```
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```

- All lines must be limited to 72 characters
- For `<scope>`, you may use:
- `app` for an application-wide change

This comment was marked as spam.

This comment was marked as spam.

- `datastore`
- `pubsub`
- `storage`
- etc.

Be sure to read the AngularJS [contributing document][ngcontributing]. For a thorough explanation, see the [AngularJS Git Commit Message Conventions doc][commitdoc].

This comment was marked as spam.

This comment was marked as spam.


## Contributor License Agreements

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

This comment was marked as spam.

[commitdoc]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#