diff --git a/contributing.md b/contributing.md index d676ea56f..0c2eb25f8 100644 --- a/contributing.md +++ b/contributing.md @@ -4,6 +4,7 @@ See the [contributing docs](https://github.com/yeoman/yeoman/blob/master/contrib Additionally for this generator: +* Please submit PRs to the `canary` branch, it is the main development branch for this generator. * When submitting an issue, please follow the [guidelines](https://github.com/yeoman/yeoman/blob/master/contributing.md#issue-submission). Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue. * When submitting a PR, make sure that the commit messages match the [AngularJS conventions][commit-message-format] (see below). * When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix. diff --git a/readme.md b/readme.md index 8bc2dcaac..da6a851d1 100644 --- a/readme.md +++ b/readme.md @@ -384,6 +384,10 @@ An example server component in `server/api` See the [contributing docs](https://github.com/DaftMonk/generator-angular-fullstack/blob/master/contributing.md) +This project has 2 main branches: `master` and `canary`. The `master` branch is where the current stable code lives and should be used for production setups. The `canary` branch is the main development branch, this is where PRs should be submitted to (backport fixes may be applied to `master`). + +By seperating the current stable code from the cutting-edge development we hope to provide a stable and efficient workflow for users and developers alike. + When submitting an issue, please follow the [guidelines](https://github.com/yeoman/yeoman/blob/master/contributing.md#issue-submission). Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue. When submitting a PR, make sure that the commit messages match the [AngularJS conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/).