docs: add contribution guidelines (#8)

closes #4

CONTRIBUTING.md

@@ -0,0 +1,146 @@
+# Contributing
+
+We appreciate all kinds of contributions. As a contributor, here are the guidelines we would like you to follow:
+
+ - [Issues and Bugs](#issue)
+ - [Feature Requests](#feature)
+ - [Submission Guidelines](#submit-pr)
+ - [Coding Rules](#rules)
+ - [Commit Message Guidelines](#commit)
+ - [Signing the CLA](#cla)
+
+
+## <a name="issue"></a> Found an Issue?
+If you find a bug in the source code or a mistake in the documentation, you can help us by
+[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Including an issue 
+reproduction (via StackBlitz, JsBin, Plunkr, etc.) is the absolute best way to help the team quickly
+diagnose the problem. Screenshots are also helpful.
+
+You can help the team even more and [submit a Pull Request](#submit-pr) with a fix.
+
+
+### <a name="submit-issue"></a> Submitting an Issue
+If your issue appears to be a bug, and hasn't been reported, open a new issue.
+Providing the following information will increase the
+chances of your issue being dealt with quickly:
+
+* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
+* **Angular and @sbb-esta/angular-public Versions** - which versions of Angular and @sbb-esta/angular-public are affected
+* **Motivation for or Use Case** - explain what are you trying to do and why the current behavior
+    is a bug for you
+* **Browsers and Operating System** - is this a problem with all browsers?
+* **Reproduce the Error** - provide a live example (using StackBlitz or similar) or a unambiguous set of steps
+* **Screenshots** - Due to the visual nature of @sbb-esta/angular-public, screenshots can help the team
+    triage issues far more quickly than a text description.
+* **Related Issues** - has a similar issue been reported before?
+* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
+    causing the problem (line of code or commit)
+
+You can file new issues by providing the above information [here](https://github.com/SchweizerischeBundesbahnen/sbb-angular/issues/new).
+
+
+### <a name="submit-pr"></a> Submitting a Pull Request (PR)
+Before you submit your Pull Request (PR) consider the following guidelines:
+
+* Make your changes in a new git branch:
+
+     ```shell
+     git checkout -b my-fix-branch master
+     ```
+
+* Create your patch, **including appropriate test cases**.
+* Follow our [Coding Rules](#rules).
+* Test your changes with our supported browsers and screen readers.
+* Run tests via `ng test @sbb-esta/angular-public` and ensure that all tests pass.
+* Commit your changes using a descriptive commit message that follows our
+  [commit message conventions](#commit). Adherence to these conventions
+  is necessary because release notes are automatically generated from these messages.
+
+     ```shell
+     git commit -a
+     ```
+  Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
+
+* Push your branch to GitHub:
+
+    ```shell
+    git push my-fork my-fix-branch
+    ```
+
+* In GitHub, send a pull request to `sbb-angular:master`.
+
+
+## <a name="rules"></a> Coding Rules
+This project uses [prettier](https://prettier.io/) and [tslint](https://palantir.github.io/tslint/) rules to enforce code style.
+The max line length is 100 characters.
+
+A short introduction to the rules is as follows (Run `npm run lint` to check validity):
+
+```
+const NUMBER_VALUE = 3;
+let stringValue = 'value';
+function nameOfTheFunction() { ... }
+
+class SpecialClass {
+  somePublicValue = true;
+  protected _protectedValue = 'some value';
+  private _privateValue = 5;
+
+  aPublicMethod() { ... }
+  protected _protectedMethod() { ... }
+  private _privateMethod() { ... }
+}
+```
+
+## <a name="commit"></a> Commit Message Guidelines
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/) to generate the changelog.
+
+### Commit Message Format
+```
+<type>(<optional scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
+to read on GitHub as well as in various git tools.
+
+### Type
+Must be one of the following:
+
+* **feat**: A new feature
+* **fix**: A bug fix
+* **docs**: Documentation only changes
+* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
+  semi-colons, etc)
+* **refactor**: A code change that neither fixes a bug nor adds a feature
+* **perf**: A code change that improves performance
+* **test**: Adding missing tests or correcting existing tests
+* **build**: Changes that affect the build system, CI configuration or external dependencies
+            (example scopes: gulp, broccoli, npm)
+* **chore**: Other changes that don't modify `src` or `test` files
+
+### Scope
+The scope could be anything specifying place of the commit change. For example
+`datepicker`, `dialog`, etc.
+
+### Subject
+The subject contains succinct description of the change:
+
+* use the imperative, present tense: "change" not "changed" nor "changes"
+* don't capitalize first letter
+* no dot (.) at the end
+
+### 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.
+
+### Footer
+The footer should contain any information about **Breaking Changes** and is also the place to
+reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines.
+The rest of the commit message is then used for this.

README.md

@@ -1,6 +1,7 @@
 # SBB Components and Design for Angular
 
 This is the repository for the Angular component library for SBB.
+It is generated, maintained, tested, linted and built with the [Angular CLI](https://cli.angular.io/).
 
 [Documentation/Showcase](https://angular.app.sbb.ch/latest/)
 
@@ -23,3 +24,15 @@ The package containing SBB icons as components.
 The package containg the components/modules for public SBB websites.
 
 [Component List](https://angular.app.sbb.ch/latest/components-list)
+
+## Browser and screen reader support
+
+This library supports the most recent two versions of all major browsers: Chrome (including Android), Firefox, Safari (including iOS), and IE11 / Edge.
+
+We aim for great user experience with the following screen readers:
+
+Windows: NVDA and JAWS with IE11 / FF / Chrome.
+macOS: VoiceOver with Safari / Chrome.
+iOS: VoiceOver with Safari
+Android: Android Accessibility Suite (formerly TalkBack) with Chrome.
+Chrome OS: ChromeVox with Chrome.

package.json

@@ -54,7 +54,7 @@
   "bugs": {
     "url": "https://github.com/SchweizerischeBundesbahnen/sbb-angular/issues"
   },
-  "homepage": "https://sbb-angular.app.sbb.ch/latest",
+  "homepage": "https://angular.app.sbb.ch/latest",
   "dependencies": {
     "@angular/animations": "^7.2.15",
     "@angular/cdk": "^7.3.7",

projects/angular-showcase/package.json

@@ -12,5 +12,5 @@
   "bugs": {
     "url": "https://github.com/SchweizerischeBundesbahnen/sbb-angular/issues"
   },
-  "homepage": "https://sbb-angular.app.sbb.ch/latest"
+  "homepage": "https://angular.app.sbb.ch/latest"
 }

projects/sbb-esta/angular-business/README.md

@@ -2,6 +2,6 @@
 
 This is the repository for the Angular component library for SBB.
 
-[Documentation/Showcase](https://sbb-angular.app.sbb.ch/latest/)
+[Documentation/Showcase](https://angular.app.sbb.ch/latest/)
 
 [Design Specification](https://digital.sbb.ch/)

projects/sbb-esta/angular-business/package.json

@@ -12,7 +12,7 @@
   "bugs": {
     "url": "https://github.com/SchweizerischeBundesbahnen/sbb-angular/issues"
   },
-  "homepage": "https://sbb-angular.app.sbb.ch/latest",
+  "homepage": "https://angular.app.sbb.ch/latest",
   "peerDependencies": {
     "@angular/common": "^7.2.0",
     "@angular/core": "^7.2.0"

projects/sbb-esta/angular-icons/README.md

@@ -2,4 +2,4 @@
 
 This is icon library for the SBB Angular libraries.
 
-For a list of icons go to https://sbb-angular.app.sbb.ch/latest/icons-list
+For a list of icons go to https://angular.app.sbb.ch/latest/icons-list

projects/sbb-esta/angular-icons/package.json

@@ -12,7 +12,7 @@
   "bugs": {
     "url": "https://github.com/SchweizerischeBundesbahnen/sbb-angular/issues"
   },
-  "homepage": "https://sbb-angular.app.sbb.ch/latest",
+  "homepage": "https://angular.app.sbb.ch/latest",
   "schematics": "./schematics/collection.json",
   "peerDependencies": {
     "@angular/common": "^7.2.0",

projects/sbb-esta/angular-public/README.md

@@ -2,6 +2,6 @@
 
 This is the repository for the Angular component library for SBB.
 
-[Documentation/Showcase](https://sbb-angular.app.sbb.ch/latest/)
+[Documentation/Showcase](https://angular.app.sbb.ch/latest/)
 
 [Design Specification](https://digital.sbb.ch/)

projects/sbb-esta/angular-public/package.json

@@ -12,7 +12,7 @@
   "bugs": {
     "url": "https://github.com/SchweizerischeBundesbahnen/sbb-angular/issues"
   },
-  "homepage": "https://sbb-angular.app.sbb.ch/latest",
+  "homepage": "https://angular.app.sbb.ch/latest",
   "peerDependencies": {
     "@angular/common": "^7.2.0",
     "@angular/core": "^7.2.0",

tslint.json

@@ -12,20 +12,12 @@
     "comment-format": [true, "check-space"],
     "curly": true,
     "deprecation": false,
-    "eofline": true,
     "forin": true,
     "import-blacklist": [true, "rxjs/Rx"],
     "import-spacing": true,
     "indent": [true, "spaces"],
     "interface-over-type-literal": true,
     "label-position": true,
-    "max-line-length": [
-      true,
-      {
-        "limit": 120,
-        "ignore-pattern": "^import |^export {(.*?)}"
-      }
-    ],
     "member-access": false,
     "member-ordering": [
       true,