Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Apr 1, 2019
Merged

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

merged 1 commit into from
Apr 1, 2019

Conversation

EnricoVogt
Copy link
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
Copy link
Member

@brandonroberts brandonroberts left a comment

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
Copy link
Contributor Author

EnricoVogt commented Mar 31, 2019 •
edited
Loading

I have changed this.

@brandonroberts
Copy link
Member

brandonroberts commented Apr 1, 2019 •
edited
Loading

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
modules/router-store/src/router_store_module.ts Outdated
},
],
})
@NgModule()
Copy link
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({})

Copy link
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
Copy link
Collaborator

ngrxbot commented Apr 1, 2019

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