Skip to content

Commit 7469362

Browse files
committed
feat(docs): Inform users/developers of the canary branch
Changes: - Update readme.md - Update contributing.md
1 parent 3a99277 commit 7469362

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

Diff for: contributing.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ See the [contributing docs](https://github.com/yeoman/yeoman/blob/master/contrib
44

55
Additionally for this generator:
66

7+
* Please submit PRs to the `canary` branch, it is the main development branch for this generator.
78
* 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.
89
* When submitting a PR, make sure that the commit messages match the [AngularJS conventions][commit-message-format] (see below).
910
* When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.

Diff for: readme.md

+4
Original file line numberDiff line numberDiff line change
@@ -384,6 +384,10 @@ An example server component in `server/api`
384384

385385
See the [contributing docs](https://github.com/DaftMonk/generator-angular-fullstack/blob/master/contributing.md)
386386

387+
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`).
388+
389+
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.
390+
387391
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.
388392

389393
When submitting a PR, make sure that the commit messages match the [AngularJS conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/).

0 commit comments

Comments
 (0)