docs: swap default branch, document branches in CONTRIBUTING.md

imhoffd · imhoffd · commit 56017c401ff0 · 2018-07-25T20:48:58.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,17 +2,10 @@
 
 Please see each package's `CHANGELOG.md` for changes.
 
-* **`ionic`**:
-  [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/master/packages/ionic/CHANGELOG.md)
-* **`@ionic/cli-framework`**:
-  [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/master/packages/%40ionic/cli-framework/CHANGELOG.md)
-* **`@ionic/cli-utils`**:
-  [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/master/packages/%40ionic/cli-utils/CHANGELOG.md)
-* **`@ionic/discover`**:
-  [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/master/packages/%40ionic/discover/CHANGELOG.md)
-* **`@ionic/lab`**:
-  [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/master/packages/%40ionic/lab/CHANGELOG.md)
-* **`@ionic/schematics-angular`**:
-  [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/master/packages/%40ionic/schematics-angular/CHANGELOG.md)
-* **`@ionic/v1-toolkit`**:
-  [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/master/packages/%40ionic/v1-toolkit/CHANGELOG.md)
+* **`ionic`**: [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/develop/packages/ionic/CHANGELOG.md)
+* **`@ionic/cli-framework`**: [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/develop/packages/%40ionic/cli-framework/CHANGELOG.md)
+* **`@ionic/cli-utils`**: [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/develop/packages/%40ionic/cli-utils/CHANGELOG.md)
+* **`@ionic/discover`**: [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/develop/packages/%40ionic/discover/CHANGELOG.md)
+* **`@ionic/lab`**: [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/develop/packages/%40ionic/lab/CHANGELOG.md)
+* **`@ionic/schematics-angular`**: [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/develop/packages/%40ionic/schematics-angular/CHANGELOG.md)
+* **`@ionic/v1-toolkit`**: [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/develop/packages/%40ionic/v1-toolkit/CHANGELOG.md)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,6 +4,13 @@
 Page](https://ionicframework.com/support) for general support questions. The
 issues on GitHub should be reserved for bug reports and feature requests.
 
+### Branches
+
+* [`develop`](https://github.com/ionic-team/ionic-cli/tree/develop): **development** branch
+* [`master`](https://github.com/ionic-team/ionic-cli/tree/master): **stable** version (`npm install -g ionic`)
+* [`3.x`](https://github.com/ionic-team/ionic-cli/tree/3.x): **previous** version (`npm install -g ionic@3`)
+* [`2.x`](https://github.com/ionic-team/ionic-cli/tree/2.x): **legacy** version (`npm install -g ionic@legacy`)
+
 ### Bug Reports
 
 Run the command(s) with `--verbose` to produce debugging output. We may ask for
@@ -39,29 +46,20 @@ The Ionic CLI is organized into a monorepo. Here are the packages:
 
 ##### General Purpose
 
-* [`packages/ionic`](https://github.com/ionic-team/ionic-cli/tree/master/packages/ionic):
-  Ionic CLI executable.
-* [`packages/@ionic/cli-utils`](https://github.com/ionic-team/ionic-cli/tree/master/packages/%40ionic/cli-utils):
-  Ionic CLI library and utilities.
-* [`packages/@ionic/cli-framework`](https://github.com/ionic-team/ionic-cli/tree/master/packages/%40ionic/cli-framework):
-  Framework for command-line programs.
-* [`packages/@ionic/discover`](https://github.com/ionic-team/ionic-cli/tree/master/packages/%40ionic/discover):
-  Service discovery library used for `ionic serve` with the [Ionic
-  DevApp](https://ionicframework.com/docs/pro/devapp/).
-* [`packages/@ionic/lab`](https://github.com/ionic-team/ionic-cli/tree/master/packages/%40ionic/lab):
-  Utility CLI for Ionic Lab, used by `ionic serve`.
+* [`packages/ionic`](https://github.com/ionic-team/ionic-cli/tree/develop/packages/ionic): Ionic CLI executable.
+* [`packages/@ionic/cli-utils`](https://github.com/ionic-team/ionic-cli/tree/develop/packages/%40ionic/cli-utils): Ionic CLI library and utilities.
+* [`packages/@ionic/cli-framework`](https://github.com/ionic-team/ionic-cli/tree/develop/packages/%40ionic/cli-framework): Framework for command-line programs.
+* [`packages/@ionic/discover`](https://github.com/ionic-team/ionic-cli/tree/develop/packages/%40ionic/discover): Service discovery library used for `ionic serve` with the [Ionic DevApp](https://ionicframework.com/docs/pro/devapp/).
+* [`packages/@ionic/lab`](https://github.com/ionic-team/ionic-cli/tree/develop/packages/%40ionic/lab): Utility CLI for Ionic Lab, used by `ionic serve`.
 
 ##### Ionic/Angular 4+
 
-* [`packages/@ionic/ng-toolkit`](https://github.com/ionic-team/ionic-cli/tree/master/packages/%40ionic/ng-toolkit):
-  Builders for Ionic/Angular 4+.
-* [`packages/@ionic/schematics-angular`](https://github.com/ionic-team/ionic-cli/tree/master/packages/%40ionic/schematics-angular):
-  Schematics for `ng generate`.
+* [`packages/@ionic/ng-toolkit`](https://github.com/ionic-team/ionic-cli/tree/develop/packages/%40ionic/ng-toolkit): Builders for Ionic/Angular 4+.
+* [`packages/@ionic/schematics-angular`](https://github.com/ionic-team/ionic-cli/tree/develop/packages/%40ionic/schematics-angular): Schematics for `ng generate`.
 
 ##### Ionic 1
 
-* [`packages/@ionic/v1-toolkit`](https://github.com/ionic-team/ionic-cli/tree/master/packages/%40ionic/v1-toolkit):
-  Utility CLI for Ionic v1 Apps, used by `ionic serve`.
+* [`packages/@ionic/v1-toolkit`](https://github.com/ionic-team/ionic-cli/tree/develop/packages/%40ionic/v1-toolkit): Utility CLI for Ionic v1 Apps, used by `ionic serve`.
 
 #### Toolset
 
@@ -126,12 +124,11 @@ Guide](https://nodejs.org/en/docs/guides/debugging-getting-started/).
 
 TODO: Be helpful about where to look for commands, utilities, etc.
 
-##### Publishing Steps
+##### Publishing
 
-1. Cancel any watch scripts.
-1. Write notable changes in the package(s)'s `CHANGELOG.md` file(s).
-1. For...
+Publishing occurs in CI when new changes are merged into `master`.
 
-    * ...testing releases: `npm run publish:testing`
-    * ...canary releases: `npm run publish:canary`
-    * ...stable releases: `npm run publish`
+To publish **testing** versions, follow these steps:
+
+1. Cancel any watch scripts.
+1. Run `npm run publish:testing`
diff --git a/README.md b/README.md
@@ -6,15 +6,6 @@
 The Ionic command line interface (CLI) is your go-to tool for developing
 [Ionic][ionic-homepage] apps.
 
-We have several branches for CLI versions:
-
-* [`master`](https://github.com/ionic-team/ionic-cli) (stable): `npm install -g
-  ionic`
-* [`3.x`](https://github.com/ionic-team/ionic-cli/tree/3.x) (old): `npm install
-  -g ionic@3`
-* [`2.x`](https://github.com/ionic-team/ionic-cli/tree/2.x) (legacy): `npm
-  install -g ionic@legacy`
-
 :book: **Documentation**:
 [https://beta.ionicframework.com/docs/cli/overview][ionic-cli-docs]
 
@@ -23,8 +14,7 @@ general support questions. The issues on GitHub should be reserved for bug
 reports and feature requests.
 
 :sparkling_heart: **Want to contribute?** Please see
-[CONTRIBUTING.md](https://github.com/ionic-team/ionic-cli/blob/master/CONTRIBUTING.md).
-
+[CONTRIBUTING.md](https://github.com/ionic-team/ionic-cli/blob/develop/CONTRIBUTING.md).
 
 [ionic-homepage]: https://ionicframework.com
 [ionic-cli-docs]: https://beta.ionicframework.com/docs/cli/overview
diff --git a/packages/ionic/CHANGELOG.md b/packages/ionic/CHANGELOG.md
@@ -28,14 +28,14 @@ Aside from a few edge cases listed below, upgrading to CLI 4 should be seamless.
 * Support for legacy Ionic Cloud ended on January 31st, 2018. The `ionic upload` and `ionic package` commands have been removed from the CLI. Support for [Ionic Pro](https://ionicframework.com/pro/) will be a major focus for the CLI going forward. :ok_hand:
 * The `app_id` property in `ionic.config.json` has been renamed to `pro_id` and is now optional (see [#3038](https://github.com/ionic-team/ionic-cli/issues/3038)). The CLI automatically detects this and changes it, but this notice is here if your build scripts rely on the setting.
 * `ionic build` will no longer run `cordova prepare`. Instead, run `ionic cordova prepare <platform>`, which performs an Ionic build beforehand.
-* Ionic Lab has been moved into the [`@ionic/lab`](https://github.com/ionic-team/ionic-cli/tree/master/packages/@ionic/lab) package, which will need to be installed for Lab to work.
+* Ionic Lab has been moved into the [`@ionic/lab`](https://github.com/ionic-team/ionic-cli/tree/develop/packages/@ionic/lab) package, which will need to be installed for Lab to work.
 * The `conference` starter template has been removed from `ionic start`. To clone existing apps (as opposed to starting new apps from starter templates), please use the app's repository URL. For example, to create the conference app, use `ionic start "Conference App" https://github.com/ionic-team/ionic-conference-app`.
 * The `--display-name` option for `ionic start` has been removed. The `name` argument is now used as the display name and slugified for directory name, package name, etc. To provide a custom slug, use `--project-id` (see [#3038](https://github.com/ionic-team/ionic-cli/issues/3038)).
 * The `ionic:watch:before` npm script hook has been renamed to `ionic:serve:before`, but behaves the same.
 * `ionic doctor check` will now _only_ print issues and exit with exit code 1 if issues are found. Use `ionic doctor treat` to attempt automatic fixes.
 * `ionic doctor ignore` has been removed in favor of `ionic config set -g doctor.issues.<issue>.ignored true`).
-* Ionic 1 build/serve functionality has been moved into the [`@ionic/v1-toolkit`](https://github.com/ionic-team/ionic-cli/tree/master/packages/@ionic/v1-toolkit) package, which will need to be installed in your Ionic 1 project(s). The file watcher, [chokidar](https://github.com/paulmillr/chokidar), has been updated to 2.0.0, which will require those using `watchPatterns` to [always use POSIX-style slashes](https://github.com/paulmillr/chokidar/blob/master/CHANGELOG.md#chokidar-200-dec-29-2017) (not an issue if you've never used a backslash in globs for Windows).
-* The gulp integration has been removed from the CLI and put into the [`@ionic/v1-toolkit`](https://github.com/ionic-team/ionic-cli/tree/master/packages/@ionic/v1-toolkit) package, which is only for Ionic v1 apps.
+* Ionic 1 build/serve functionality has been moved into the [`@ionic/v1-toolkit`](https://github.com/ionic-team/ionic-cli/tree/develop/packages/@ionic/v1-toolkit) package, which will need to be installed in your Ionic 1 project(s). The file watcher, [chokidar](https://github.com/paulmillr/chokidar), has been updated to 2.0.0, which will require those using `watchPatterns` to [always use POSIX-style slashes](https://github.com/paulmillr/chokidar/blob/master/CHANGELOG.md#chokidar-200-dec-29-2017) (not an issue if you've never used a backslash in globs for Windows).
+* The gulp integration has been removed from the CLI and put into the [`@ionic/v1-toolkit`](https://github.com/ionic-team/ionic-cli/tree/develop/packages/@ionic/v1-toolkit) package, which is only for Ionic v1 apps.
 
 #### :rocket: Enhancements
 
@@ -61,7 +61,7 @@ Aside from a few edge cases listed below, upgrading to CLI 4 should be seamless.
 #### :house: Internal
 
 * A huge amount of code refactoring has been accomplished to prepare the CLI for a scalable, flexible future. Changes in behavior and help output based upon environment and config are now trivially accomplished.
-* The [CLI Framework](https://github.com/ionic-team/ionic-cli/tree/master/packages/%40ionic/cli-framework), a (currently) internal framework for building general-purpose command-line programs, has had many features added to support the utility CLIs such as `ionic-lab` and `ionic-v1`.
+* The [CLI Framework](https://github.com/ionic-team/ionic-cli/tree/develop/packages/%40ionic/cli-framework), a (currently) internal framework for building general-purpose command-line programs, has had many features added to support the utility CLIs such as `ionic-lab` and `ionic-v1`.
 * Ionic Lab has been rebuilt using [StencilJS](https://stenciljs.com) and now works for any Ionic Framework version.
 
 ## Older Changes
