From 39df9141587b48959d1cb44197f3526c07103059 Mon Sep 17 00:00:00 2001 From: Amit Bansil Date: Wed, 3 Aug 2016 18:32:22 -0400 Subject: [PATCH] docs(contributing): switch policy from git flow to a simple branch off master scheme --- development.md => CONTRIBUTING.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) rename development.md => CONTRIBUTING.md (65%) diff --git a/development.md b/CONTRIBUTING.md similarity index 65% rename from development.md rename to CONTRIBUTING.md index 177a29ef..8e12baa7 100644 --- a/development.md +++ b/CONTRIBUTING.md @@ -2,11 +2,9 @@ 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 @@ -14,7 +12,7 @@ Please format your commit messages to match [Angular's Conventions](https://gith ## 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