ci: add CONTRIBUTING as a template and various changes

Added types from the commit validation script to CONTRIBUTING. Added
packages names from the package script to the scope section. Added
examples of good commit messages.

Also corrected some texts.

Author: hansl

CONTRIBUTING.md

@@ -180,41 +180,65 @@ If the commit reverts a previous commit, it should begin with `revert: `, follow
 ### Type
 Must be one of the following:
 
-* **build**: Changes that affect the build system or external dependencies
-* **ci**: Changes to our CI configuration files and scripts
-* **docs**: Documentation only changes
-* **feat**: A new feature
-* **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)
-* **test**: Adding missing tests or correcting existing tests
+* **build**: Changes that affect the build system or external dependencies. [2]
+* **ci**: Changes to our CI configuration files and scripts. [2]
+* **docs**: Documentation only changes. 
+* **feat**: A new feature. [1]
+* **fix**: A bug fix. [1]
+* **refactor**: A code change that neither fixes a bug nor adds a feature 
+* **release**: A release commit. Must only include version changes. [2]
+* **revert**: A git commit revert. The description must include the original commit message. [2]
+* **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. 
+
+
+<sup>[1] This type MUST have a scope. See the next section for more information.</sup><br/>
+<sup>[2] This type MUST NOT have a scope. It only applies to general scripts and tooling.</sup>
 
 ### 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-devkit/core**
+* **@angular/cli**
+* **@angular/pwa**
+* **@angular-devkit/architect**
+* **@angular-devkit/architect-cli**
+* **@angular-devkit/build-angular**
+* **@angular-devkit/build-ng-packagr**
 * **@angular-devkit/build-optimizer**
+* **@angular-devkit/build-webpack**
+* **@angular-devkit/core**
 * **@angular-devkit/schematics**
 * **@angular-devkit/schematics-cli**
+* **@ngtools/webpack**
 * **@schematics/angular**
 * **@schematics/schematics**
+* **@schematics/update**
 
-There are currently a few exceptions to the "use package name" rule:
-
-* **packaging**: used for changes that change the npm package layout in all of our packages, e.g. public path changes, package.json changes done to all packages, d.ts file/format changes, changes to bundles, etc.
-* **changelog**: used for updating the release notes in CHANGELOG.md
-* none/empty string: useful for `style`, `test` and `refactor` changes that are done across all packages (e.g. `style: add missing semicolons`)
 
 ### Subject
 The subject contains succinct description of the change:
 
 * use the imperative, present tense: "change" not "changed" nor "changes"
 * don't capitalize first letter
+* be concise and direct
 * no dot (.) at the end
 
+### Examples
+Examples of valid commit messages:
+
+* `fix(@angular/cli): prevent the flubber from grassing`
+* `refactor(@schematics/angular): move all JSON classes together`
+
+Examples of invalid commit messages:
+* `fix(@angular/cli): add a new XYZ command`
+
+  This is a feature, not a fix.
+* `ci(@angular/cli): fix publishing workflow`
+
+  The `ci` type cannot have a scope.
+
 ### Body
 Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
 The body should include the motivation for the change and contrast this with previous behavior.

README.md

@@ -25,28 +25,25 @@ This is the home of the DevKit and the Angular CLI code. You can find the Angula
 
 
 
-----
-
-This is the home for all the tools and libraries built to assist developers with their Angular applications.
-
 ### Quick Links
 [Gitter](https://gitter.im/angular/angular-cli) | [Contributing](https://github.com/angular/angular-cli/blob/master/CONTRIBUTING.md) | [Angular CLI](http://github.com/angular/angular-cli) | 
 |---|---|---|
 
+----
+
+## The Goal of Angular CLI
+
+The Angular CLI creates, manages, builds and test your Angular projects. It's built on top of the
+Angular DevKit.
 
 ## The Goal of DevKit
 
-Our goal is to provide a large set of libraries that can be used to manage, develop, deploy and
+DevKit's goal is to provide a large set of libraries that can be used to manage, develop, deploy and
 analyze your code.
 
-This is the extension of the Angular CLI Project. Once this set of tools is done, the Angular CLI
-as it is today will become one of many interfaces available to perform those tasks. Everything
-will also be available to third party tools and IDEs.
-
-
 
 
-## Tools
+# Tools
 
 | Project | Package | Version | Links |
 |---|---|---|---|
@@ -55,7 +52,7 @@ will also be available to third party tools and IDEs.
 
 
 
-## Packages
+# Packages
 This is a monorepo which contains many packages:
 
 

scripts/templates.ts

@@ -9,17 +9,27 @@
 import { logging } from '@angular-devkit/core';
 import * as fs from 'fs';
 import * as path from 'path';
-import { packages } from '../lib/packages';
 
-export default function(_options: {}, logger: logging.Logger) {
-  const monorepo = require('../.monorepo.json');
 
-  logger.info('Building README...');
-  const readme = require('./templates/readme').default;
-  const content = readme({
-    monorepo,
-    packages,
+function _runTemplate(inputPath: string, outputPath: string, logger: logging.Logger) {
+  inputPath = path.resolve(__dirname, inputPath);
+  outputPath = path.resolve(__dirname, outputPath);
+
+  logger.info(`Building ${path.relative(path.dirname(__dirname), outputPath)}...`);
+
+  const template = require(inputPath).default;
+  const content = template({
+    monorepo: require('../.monorepo.json'),
+    packages: require('../lib/packages').packages,
     encode: (x: string) => global.encodeURIComponent(x),
+    require: (x: string) => require(path.resolve(path.dirname(inputPath), x)),
   });
-  fs.writeFileSync(path.join(__dirname, '../README.md'), content, 'utf-8');
+  fs.writeFileSync(outputPath, content, 'utf-8');
+}
+
+export default async function(_options: {}, logger: logging.Logger): Promise<number> {
+  _runTemplate('./templates/readme', '../README.md', logger);
+  _runTemplate('./templates/contributing', '../CONTRIBUTING.md', logger);
+
+  return 1;
 }