Skip to content

feat(router-store): Make usage of forRoot required (#1662)#1672

Merged
brandonroberts merged 1 commit into
ngrx:masterfrom
EnricoVogt:issue_#1662
Apr 1, 2019
Merged

feat(router-store): Make usage of forRoot required (#1662)#1672
brandonroberts merged 1 commit into
ngrx:masterfrom
EnricoVogt:issue_#1662

Conversation

@EnricoVogt

@EnricoVogt EnricoVogt commented Mar 31, 2019

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Closes #1662

What is the new behavior?

Does this PR introduce a breaking change?

[x] Yes
[ ] No

Other information

brandonroberts
brandonroberts requested changes Mar 31, 2019
View reviewed changes

@brandonroberts brandonroberts left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update the git commit message to account for the breaking change. Example format is here https://github.com/ngrx/platform/blob/master/CONTRIBUTING.md#footer

@brandonroberts brandonroberts added the Needs Cleanup Review changes needed label Mar 31, 2019
@EnricoVogt

EnricoVogt commented Mar 31, 2019 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

I have changed this.

@brandonroberts

brandonroberts commented Apr 1, 2019 •
edited
Loading

Copy link
Copy Markdown
Member

The breaking change message should show before/after usage, not changes.

BEFORE:

@NgModule({
  imports: [
    StoreRouterConnectingModule
  ]
})
export class AppModule {}

AFTER:

@NgModule({
  imports: [
    StoreRouterConnectingModule.forRoot()
  ]
})
export class AppModule {}

brandonroberts
brandonroberts requested changes Apr 1, 2019
View reviewed changes
Comment thread modules/router-store/src/router_store_module.ts Outdated
},
],
})
@NgModule()

@brandonroberts brandonroberts Apr 1, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be an empty object even if there's no metadata.

Suggested change
@NgModule()
@NgModule({})

@EnricoVogt EnricoVogt Apr 1, 2019

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh. Thanks for your advises. I hope my changes now meet the requirements.

@EnricoVogt
feat(router-store): Make usage of forRoot required (ngrx#1662)
5c7f73a 
BREAKING CHANGES:

usage of forRoot is now required for StoreRouterConnectionModule

BEFORE:

@NgModule({
  imports: [
    StoreRouterConnectingModule
  ]
})
export class AppModule {}

AFTER:

@NgModule({
  imports: [
    StoreRouterConnectingModule.forRoot()
  ]
})
export class AppModule {}
@ngrxbot

ngrxbot commented Apr 1, 2019

Copy link
Copy Markdown
Collaborator

Preview docs changes for 5c7f73a at https://previews.ngrx.io/pr1672-5c7f73a/

@brandonroberts brandonroberts removed the Needs Cleanup Review changes needed label Apr 1, 2019
@brandonroberts brandonroberts merged commit c7e1406 into ngrx:master Apr 1, 2019
@timdeschryver timdeschryver mentioned this pull request Apr 4, 2019
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@brandonroberts brandonroberts brandonroberts approved these changes

Assignees

No one assigned

Labels

Breaking Change

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Router Store: Make usage of forRoot required

3 participants

@EnricoVogt @brandonroberts @ngrxbot