Skip to content

Commit 522a6ce

Browse files
committed
docs(contributing): add back info from readme, modified
[skip ci]
1 parent 083eac9 commit 522a6ce

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

contributing.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,18 @@ Additionally for this generator:
1111
* When submitting a new feature, add tests that cover the feature.
1212
* Open Issues marked with the [EASY](https://github.com/angular-fullstack/generator-angular-fullstack/issues?q=is%3Aopen+is%3Aissue+label%3AEasy) label are believed to be easy changes, and would be good Issues to tackle for new contributors.
1313

14+
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`).
15+
16+
By separating the current stable code from the cutting-edge development we hope to provide a stable and efficient workflow for users and developers alike.
17+
18+
When submitting a PR, make sure that the commit messages match the [AngularJS conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/).
19+
20+
When submitting a bugfix, try to write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.
21+
22+
When submitting a new feature, add tests that cover the feature.
23+
1424
To run the generator:
25+
1526
1. Clone it and `cd` to its root
1627
2. `npm install`
1728
3. `npm link` (tells npm to look to your own version)

0 commit comments

Comments
 (0)