Merge branch 'master' into master

.circleci/bazel.rc

@@ -19,10 +19,10 @@ build --experimental_strict_action_env
 # Bazel doesn't calculate the memory ceiling correctly when running under Docker.
 # Limit Bazel to consuming resources that fit in CircleCI "medium" class which is the default:
 # https://circleci.com/docs/2.0/configuration-reference/#resource_class
-build --jobs=10 --local_resources=3072,2.0,1.0
+build --local_resources=2048,2.0,1.0
 
 # Also limit Bazel's own JVM heap to stay within our 4G container limit
-startup --host_jvm_args=-Xmx2G
+startup --host_jvm_args=-Xmx1G
 
 # Retry in the event of flakes, eg. https://circleci.com/gh/angular/angular/31309
 test --flaky_test_attempts=2

.circleci/config.yml

@@ -19,7 +19,6 @@ var_3: &set_bazel_options
     command: sudo cp .circleci/bazel.rc /etc/bazel.bazelrc
 
 jobs:
-
   # Enforce some static analysis invariants.
   # Note that generally, these should be checked only on the delta in each change,
   # otherwise any change to the static analysis config requires updating all the
@@ -35,8 +34,9 @@ jobs:
       # Note that this uses the version of buildifier from the docker image -
       # take care that you use the same version when you run
       # buildifier locally on your change.
-      - run: 'buildifier -mode=check $(find . -type f \( -name BUILD.bazel -or -name BUILD \)) ||
-              (echo "BUILD files not formatted. Please run ''yarn buildifier''" ; exit 1)'
+      - run:
+          'buildifier -mode=check $(find . -type f \( -name BUILD.bazel -or -name BUILD \)) ||
+          (echo "BUILD files not formatted. Please run ''yarn buildifier''" ; exit 1)'
 
   bazel:
     <<: *run_in_ngcontainer
@@ -84,7 +84,7 @@ jobs:
     steps:
       - add_ssh_keys:
           fingerprints:
-            - "c9:c2:b4:5e:13:23:b6:6d:d8:29:3e:68:c6:40:9c:ec"
+            - 'c9:c2:b4:5e:13:23:b6:6d:d8:29:3e:68:c6:40:9c:ec'
       - checkout
       - restore_cache:
           key: *cache_key
@@ -104,4 +104,4 @@ workflows:
             - test
           filters:
             branches:
-              only: master
+              only: master

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,43 @@
+## PR Checklist
+
+Please check if your PR fulfills the following requirements:
+
+- [ ] The commit message follows our guidelines: /~https://github.com/ngrx/platform/blob/master/CONTRIBUTING.md#commit
+- [ ] Tests for the changes have been added (for bug fixes / features)
+- [ ] Docs have been added / updated (for bug fixes / features)
+
+## PR Type
+
+What kind of change does this PR introduce?
+
+<!-- Please check the one that applies to this PR using "x". -->
+
+```
+[ ] Bugfix
+[ ] Feature
+[ ] Code style update (formatting, local variables)
+[ ] Refactoring (no functional changes, no api changes)
+[ ] Build related changes
+[ ] CI related changes
+[ ] Documentation content changes
+[ ] Other... Please describe:
+```
+
+## What is the current behavior?
+
+<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
+
+Issue Number: N/A
+
+## What is the new behavior?
+
+## Does this PR introduce a breaking change?
+
+```
+[ ] Yes
+[ ] No
+```
+
+<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
+
+## Other information

CONTRIBUTING.md

@@ -16,25 +16,133 @@ yarn test
 
 **Please follow these basic steps to simplify pull request reviews. If you don't you'll probably just be asked to anyway.**
 
-* Please rebase your branch against the current master.
-* Run the `Setup` command to make sure your development dependencies are up-to-date.
-* Please ensure the test suite passes before submitting a PR.
-* If you've added new functionality, **please** include tests which validate its behavior.
-* Make reference to possible [issues](/~https://github.com/ngrx/platform/issues) on PR comment.
+- Please rebase your branch against the current master.
+- Run the `Setup` command to make sure your development dependencies are up-to-date.
+- Please ensure the test suite passes before submitting a PR.
+- If you've added new functionality, **please** include tests which validate its behavior.
+- Make reference to possible [issues](/~https://github.com/ngrx/platform/issues) on PR comment.
 
 ## Submitting bug reports
 
-* Search through issues to see if a previous issue has already been reported and/or fixed.
-* Provide a _small_ reproduction using a [StackBlitz project](https://stackblitz.com/edit/ngrx-seed) or a GitHub repository.
-* Please detail the affected browser(s) and operating system(s).
-* Please be sure to state which version of Angular, node and npm you're using.
+- Search through issues to see if a previous issue has already been reported and/or fixed.
+- Provide a _small_ reproduction using a [StackBlitz project](https://stackblitz.com/edit/ngrx-seed) or a GitHub repository.
+- Please detail the affected browser(s) and operating system(s).
+- Please be sure to state which version of Angular, node and npm you're using.
 
 ## Submitting new features
 
-* We value keeping the API surface small and concise, which factors into whether new features are accepted.
-* Submit an issue with the prefix `RFC:` with your feature request.
-* The feature will be discussed and considered.
-* Once the PR is submitted, it will be reviewed and merged once approved.
+- We value keeping the API surface small and concise, which factors into whether new features are accepted.
+- Submit an issue with the prefix `RFC:` with your feature request.
+- The feature will be discussed and considered.
+- Once the PR is submitted, it will be reviewed and merged once approved.
+
+## <a name="commit"></a> Commit Message Guidelines
+
+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 NgRx change log**.
+
+### Commit Message Format
+
+Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
+format that includes a **type**, a **scope** and a **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory and the **scope** of the header is optional.
+
+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.
+
+The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
+
+Samples: (even more [samples](/~https://github.com/ngrx/platform/commits/master))
+
+```
+docs(changelog): update changelog to beta.5
+```
+
+```
+fix(release): need to depend on latest rxjs and zone.js
+
+The version in our package.json gets copied to the one we publish, and users need the latest of these.
+```
+
+### Revert
+
+If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+### Type
+
+Must be one of the following:
+
+- **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
+- **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
+- **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
+
+### Scope
+
+The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages.
+
+The following is the list of supported scopes:
+
+- **effects**
+- **entity**
+- **example**
+- **router-store**
+- **schematics**
+- **store**
+- **store-devtools**
+
+### Subject
+
+The subject contains a succinct description of the change:
+
+- use the imperative, present tense: "change" not "changed" nor "changes"
+- don't capitalize the 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.
+
+Example:
+
+```
+feat(scope): commit message
+
+BREAKING CHANGES:
+
+Describe breaking changes here
+
+BEFORE:
+
+Previous code example here
+
+AFTER:
+
+New code example here
+```
 
 ## Financial contributions
 

README.md

@@ -6,31 +6,34 @@ Reactive libraries for Angular
 
 ## Support NgRx
 
-[![Backers on Open Collective](https://opencollective.com/ngrx/sponsors/badge.svg)](#sponsors)
-[![Backers on Open Collective](https://opencollective.com/ngrx/backers/badge.svg)](#backers)
+[![Backers on Open Collective](https://opencollective.com/ngrx/tiers/backers/badge.svg)](#backers)
 
 Become a sponsor and get your logo on our README on Github with a link to your site.
 
 ### Gold Sponsors
 
-No Gold sponsors yet. [[Become a Gold sponsor](https://opencollective.com/ngrx#sponsors)]
+<a href="https://opencollective.com/ngrx/tiers/gold-sponsors/0/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/gold-sponsors/0/avatar.svg"></a>
+<a href="https://opencollective.com/ngrx/tiers/gold-sponsors/1/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/gold-sponsors/1/avatar.svg"></a>
+<a href="https://opencollective.com/ngrx/tiers/gold-sponsors/2/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/gold-sponsors/2/avatar.svg"></a>
 
 ### Silver Sponsors
 
-No Silver sponsors yet. [[Become a Silver sponsor](https://opencollective.com/ngrx#sponsors)]
+<a href="https://opencollective.com/ngrx/tiers/silver-sponsors/0/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/silver-sponsors/0/avatar.svg"></a>
+<a href="https://opencollective.com/ngrx/tiers/silver-sponsors/1/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/silver-sponsors/1/avatar.svg"></a>
+<a href="https://opencollective.com/ngrx/tiers/silver-sponsors/2/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/silver-sponsors/2/avatar.svg"></a>
 
 ### Bronze Sponsors
 
-<a href="https://opencollective.com/ngrx/sponsor/0/website" target="_blank"><img src="https://opencollective.com/ngrx/sponsor/0/avatar.svg"></a>
-<a href="https://opencollective.com/ngrx/sponsor/1/website" target="_blank"><img src="https://opencollective.com/ngrx/sponsor/1/avatar.svg"></a>
-<a href="https://opencollective.com/ngrx/sponsor/2/website" target="_blank"><img src="https://opencollective.com/ngrx/sponsor/2/avatar.svg"></a>
-<a href="https://opencollective.com/ngrx/sponsor/3/website" target="_blank"><img src="https://opencollective.com/ngrx/sponsor/3/avatar.svg"></a>
-<a href="https://opencollective.com/ngrx/sponsor/4/website" target="_blank"><img src="https://opencollective.com/ngrx/sponsor/4/avatar.svg"></a>
-<a href="https://opencollective.com/ngrx/sponsor/5/website" target="_blank"><img src="https://opencollective.com/ngrx/sponsor/5/avatar.svg"></a>
-<a href="https://opencollective.com/ngrx/sponsor/6/website" target="_blank"><img src="https://opencollective.com/ngrx/sponsor/6/avatar.svg"></a>
-<a href="https://opencollective.com/ngrx/sponsor/7/website" target="_blank"><img src="https://opencollective.com/ngrx/sponsor/7/avatar.svg"></a>
-<a href="https://opencollective.com/ngrx/sponsor/8/website" target="_blank"><img src="https://opencollective.com/ngrx/sponsor/8/avatar.svg"></a>
-<a href="https://opencollective.com/ngrx/sponsor/9/website" target="_blank"><img src="https://opencollective.com/ngrx/sponsor/9/avatar.svg"></a>
+<a href="https://opencollective.com/ngrx/tiers/bronze-sponsors/0/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/bronze-sponsors/0/avatar.svg"></a>
+<a href="https://opencollective.com/ngrx/tiers/bronze-sponsors/1/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/bronze-sponsors/1/avatar.svg"></a>
+<a href="https://opencollective.com/ngrx/tiers/bronze-sponsors/2/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/bronze-sponsors/2/avatar.svg"></a>
+<a href="https://opencollective.com/ngrx/tiers/bronze-sponsors/3/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/bronze-sponsors/3/avatar.svg"></a>
+<a href="https://opencollective.com/ngrx/tiers/bronze-sponsors/4/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/bronze-sponsors/4/avatar.svg"></a>
+<a href="https://opencollective.com/ngrx/tiers/bronze-sponsors/5/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/bronze-sponsors/5/avatar.svg"></a>
+<a href="https://opencollective.com/ngrx/tiers/bronze-sponsors/6/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/bronze-sponsors/6/avatar.svg"></a>
+<a href="https://opencollective.com/ngrx/tiers/bronze-sponsors/7/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/bronze-sponsors/7/avatar.svg"></a>
+<a href="https://opencollective.com/ngrx/tiers/bronze-sponsors/8/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/bronze-sponsors/8/avatar.svg"></a>
+<a href="https://opencollective.com/ngrx/tiers/bronze-sponsors/9/website" target="_blank"><img src="https://opencollective.com/ngrx/tiers/bronze-sponsors/9/avatar.svg"></a>
 
 ## Packages
 
@@ -44,7 +47,7 @@ No Silver sponsors yet. [[Become a Silver sponsor](https://opencollective.com/ng
 
 ## Examples
 
-- [example-app](./example-app/README.md) - Example application utilizing @ngrx libraries, showcasing common patterns and best practices. Try it on [StackBlitz](https://stackblitz.com/github/ngrx/platform/tree/61cbfe537f9df8cef3dd4a6ee0b8f483e49653f4).
+- [example-app](./projects/example-app/README.md) - Example application utilizing @ngrx libraries, showcasing common patterns and best practices. Try it on [StackBlitz](https://ngrx.github.io/platform/stackblitz.html).
 
 ## Migration