docs: update documentation for schematics and contributing

delasteve · hansl · commit 209903048177 · 2018-06-05T17:55:14.000-07:00
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,43 @@
+<!--
+IF YOU DON'T FILL OUT THE FOLLOWING INFORMATION YOUR ISSUE MIGHT BE CLOSED WITHOUT INVESTIGATING
+-->
+### Bug Report or Feature Request (mark with an `x`)
+```
+- [ ] bug report -> please search issues before submitting
+- [ ] feature request
+```
+
+### Area
+```
+- [ ] devkit
+- [ ] schematics
+```
+
+### Versions
+<!--
+Output from: `node --version` and `npm --version`.
+  Windows (7/8/10). Linux (incl. distribution). macOS (El Capitan? Sierra? High Sierra?)
+-->
+
+
+### Repro steps
+<!--
+Simple steps to reproduce this bug.
+Please include: commands run, packages added, related code changes.
+A link to a sample repo would help too.
+-->
+
+
+### The log given by the failure
+<!-- Normally this include a stack trace and some more information. -->
+
+
+### Desired functionality
+<!--
+What would like to see implemented?
+What is the usecase?
+-->
+
+
+### Mention any other details that might be useful
+<!-- Please include a link to the repo if this is related to an OSS project. -->
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 # Contributing to Angular DevKit
 
-We would love for you to contribute to Angular CLI and help make it even better
+We would love for you to contribute to DevKit and help make it even better
 than it is today! As a contributor, here are the guidelines we would like you
 to follow:
 
@@ -18,7 +18,7 @@ Help us keep Angular open and inclusive. Please read and follow our [Code of Con
 
 ## <a name="question"></a> Got a Question or Problem?
 
-Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow](https://stackoverflow.com/questions/tagged/angular-cli) where the questions should be tagged with tag `angular-cli`.
+Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow](https://stackoverflow.com/questions/tagged/angular-devkit) where the questions should be tagged with tag `angular-devkit`.
 
 StackOverflow is a much better place to ask questions since:
 
@@ -38,8 +38,7 @@ If you find a bug in the source code or a mistake in the documentation, you can
 ## <a name="feature"></a> Want a Feature?
 You can *request* a new feature by [submitting an issue](#submit-issue) to our [GitHub
 Repository][github]. If you would like to *implement* a new feature, please submit an issue with
-a proposal for your work first, to be sure that we can use it. Angular CLI is in developer preview
-and we are not ready to accept major contributions ahead of the full release.
+a proposal for your work first, to be sure that we can use it.
 Please consider what kind of change it is:
 
 * For a **Major Feature**, first open an issue and outline your proposal so that it can be
@@ -53,9 +52,9 @@ and help you to craft the change so that it is successfully accepted into the pr
 
 Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
 
-We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a minimal reproduction scenario using `ng new repro-app`. Having a reproducible scenario gives us wealth of important information without going back & forth to you with additional questions like:
+We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. Having a reproducible scenario gives us wealth of important information without going back & forth to you with additional questions like:
 
-- version of Angular CLI used
+- version of Angular DevKit used
 - `.angular-cli.json` configuration
 - 3rd-party libraries and their versions
 - and most importantly - a use-case that fails
@@ -66,13 +65,13 @@ We will be insisting on a minimal reproduce scenario in order to save maintainer
 
 Unfortunately we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that don't have enough info to be reproduced.
 
-You can file new issues by filling out our [new issue form](https://github.com/angular/angular-cli/issues/new).
+You can file new issues by filling out our [new issue form](https://github.com/angular/devkit/issues/new).
 
 
 ### <a name="submit-pr"></a> Submitting a Pull Request (PR)
 Before you submit your Pull Request (PR) consider the following guidelines:
 
-* Search [GitHub](https://github.com/angular/angular-cli/pulls) for an open or closed PR
+* Search [GitHub](https://github.com/angular/devkit/pulls) for an open or closed PR
   that relates to your submission. You don't want to duplicate effort.
 * Please sign our [Contributor License Agreement (CLA)](#cla) before sending PRs.
   We cannot accept code without this.
@@ -84,7 +83,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
 
 * Create your patch, **including appropriate test cases**.
 * Follow our [Coding Rules](#rules).
-* Run the full Angular CLI test suite, as described in the [developer documentation][dev-doc],
+* Run the full Angular DevKit test suite, as described in the [developer documentation][dev-doc],
   and ensure that all tests pass (coming soon).
 * Commit your changes using a descriptive commit message that follows our
   [commit message conventions](#commit). Adherence to these conventions
@@ -101,10 +100,10 @@ Before you submit your Pull Request (PR) consider the following guidelines:
     git push origin my-fix-branch
     ```
 
-* In GitHub, send a pull request to `angular-cli:master`.
+* In GitHub, send a pull request to `devkit:master`.
 * If we suggest changes then:
   * Make the required updates.
-  * Re-run the Angular CLI test suites to ensure tests are still passing.
+  * Re-run the Angular DevKit test suites to ensure tests are still passing.
   * Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
 
     ```shell
@@ -155,7 +154,7 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
 
 We have very precise rules over how our git commit messages can be formatted.  This leads to **more
 readable messages** that are easy to follow when looking through the **project history**.  But also,
-we use the git commit messages to **generate the Angular CLI change log**.
+we use the git commit messages to **generate the Angular DevKit change log**.
 
 ### Commit Message Format
 Each commit message consists of a **header**, a **body** and a **footer**.  The header has a special
@@ -187,19 +186,19 @@ Must be one of the following:
 * **fix**: A bug fix
 * **perf**: A code change that improves performance
 * **refactor**: A code change that neither fixes a bug nor adds a feature
-* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
-  semi-colons, etc)
+* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 * **test**: Adding missing tests or correcting existing tests
 
 ### Scope
 The scope should be the name of the npm package affected as perceived by the person reading changelog generated from the commit messages.
 
 The following is the list of supported scopes:
 
-* **@angular/cli**
-* **@ngtools/json-schema**
-* **@ngtools/logger**
-* **@ngtools/webpack**
+* **@angular-devkit/core**
+* **@angular-devkit/build-optimizer**
+* **@angular-devkit/schematics**
+* **@schematics/angular**
+* **@schematics/schematics**
 
 There are currently a few exceptions to the "use package name" rule:
 
@@ -240,8 +239,8 @@ changes to be accepted, the CLA must be signed. It's a quick process, we promise
 [commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
 [corporate-cla]: http://code.google.com/legal/corporate-cla-v1.0.html
 [dev-doc]: https://github.com/angular/angular-cli#development-hints-for-working-on-angular-cli
-[GitHub]: https://github.com/angular/angular-cli
+[GitHub]: https://github.com/angular/devkit
 [gitter]: https://gitter.im/angular/angular-cli
 [individual-cla]: http://code.google.com/legal/individual-cla-v1.0.html
 [js-style-guide]: https://google.github.io/styleguide/jsguide.html
-[stackoverflow]: http://stackoverflow.com/questions/tagged/angular-cli
+[stackoverflow]: http://stackoverflow.com/questions/tagged/angular-devkit
diff --git a/packages/angular_devkit/schematics/collection-schema.json b/packages/angular_devkit/schematics/collection-schema.json
@@ -6,21 +6,26 @@
   "properties": {
     "schematics": {
       "type": "object",
+      "description": "A map of schematic names to schematic details",
       "properties": {
         "additionalProperty": {
           "type": "object",
           "properties": {
             "factory": {
-              "type": "string"
+              "type": "string",
+              "description": "A folder or file path to the schematic factory"
             },
             "description": {
-              "type": "string"
+              "type": "string",
+              "description": "A description for the schematic"
             },
             "extends": {
-              "type": "string"
+              "type": "string",
+              "description": "An schematic override. It can be a local schematic or from another collection (in the format 'collection:schematic')"
             },
             "schema": {
-              "type": "string"
+              "type": "string",
+              "description": "Location of the schema.json file of the schematic"
             }
           },
           "required": [
