Skip to content

Commit

Permalink
docs(contributing): switch policy from git flow to a simple branch of…
Browse files Browse the repository at this point in the history
…f master scheme
  • Loading branch information
amit-bansil committed Aug 8, 2016
1 parent d0cdf96 commit 39df914
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions development.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,17 @@

This document outlines our development processes.

## Git Flow
## Pull Requests

We use the [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model for this project. We recommend installing the [git flow tool](https://github.com/nvie/gitflow/wiki/Installation) and github's [commandline](https://hub.github.com/) and [desktop](https://desktop.github.com/) suites. Note that it is not necessary to manually bump versions in package.json, semantic-version automatically computes that for us just before each release. Also note that we don't bother with release branches.

Please issue github pull requests against develop instead of merging features directly in.
All changes to this project should be made in the form of pull requests against master. Use snake-case prefixed by 'feat/' or 'fix/' for features/fixes. Feel free to use any of the commit types listed [here](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#type) as well. Note that when pull requests are merged in they will be automatically released to npm by (Travis CI)[https://travis-ci.org/] and (semantic-release)[https://github.com/semantic-release/semantic-release] so make sure to fully test.

## Commit Messages

Please format your commit messages to match [Angular's Conventions](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines). These messages are parsed using semantic release to determine version numbers so it is important that you stick to them exactly. We recommend using the `npm run commit` script installed in this project to draft conformant messages.

## Linting

The style of all js files in this project are strictly checked using [jscs](http://jscs.info/) and [eslint](http://eslint.org/) before any pull request/release is made. You can manually check your local clone using the `gulp lint` command (don't forget to `nom install -g gulp` if you haven't already). Many problems can be automatically fixed by `gulp jscs-fix`. Don't forget to commit before running jscs-fix in case you want to back out changes.
The style of all js files in this project are strictly checked using [jscs](http://jscs.info/) and [eslint](http://eslint.org/) before any pull request/release is made. You can manually check your local clone using the `gulp lint` command (don't forget to `nom install -g gulp` if you haven't already). Many problems can be automatically fixed by `gulp jscs-fix`. Don't forget to commit before running jscs-fix in case you end up needing to back out changes.

## Testing

Expand Down

0 comments on commit 39df914

Please sign in to comment.