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.

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

Add v2 update docs #1013

Merged
merged 3 commits into from Nov 5, 2020
Merged

Add v2 update docs #1013

merged 3 commits into from Nov 5, 2020

Conversation

pirj
Copy link
Member

@pirj pirj commented Aug 20, 2020

Better viewed as https://github.com/rubocop-hq/rubocop-rspec/blob/add-v2-migration-docs/docs/modules/ROOT/pages/upgrade_to_version_2.adoc

TODO


Before submitting the PR make sure the following are checked:

  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • [-] Added tests.
  • Updated documentation.
  • [-] Added an entry to the CHANGELOG.md if the new code introduces user-observable changes.
  • The build (bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).

@pirj pirj self-assigned this Aug 20, 2020
@pirj pirj added this to the 2.0 milestone Aug 20, 2020
@pirj
Copy link
Member Author

pirj commented Aug 20, 2020

@sl4vr appreciate if you could take a look.

Copy link
Member

@Darhazer Darhazer left a comment

Choose a reason for hiding this comment

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

Great job! 🙇

@pirj
Copy link
Member Author

pirj commented Aug 22, 2020

Extended the guide in regards to this change rubocop/rubocop#8490

@pirj pirj mentioned this pull request Oct 22, 2020
4 tasks
@pirj pirj changed the base branch from master to release-2.0 October 22, 2020 17:31
@pirj
Copy link
Member Author

pirj commented Oct 22, 2020

@bquorning Green.
Besides all, this includes information on how to migrate to 2.0 given we decide to merge #956 in its current form.

Copy link
Collaborator

@bquorning bquorning left a comment

Choose a reason for hiding this comment

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

Sorry about the many nitpick comments here.

I believe this PR should be the last one to be merged into release-2.0, as it may still change depending on the other PRs getting merged.

docs/modules/ROOT/pages/index.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/index.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
@bquorning bquorning mentioned this pull request Oct 22, 2020
@pirj
Copy link
Member Author

pirj commented Oct 22, 2020

Thanks for proofreading, @bquorning !

I believe this PR should be the last one to be merged into release-2.0

Agree 👍

@pirj pirj force-pushed the add-v2-migration-docs branch 2 times, most recently from d155443 to 01e4e2b Compare October 22, 2020 21:35
@pirj
Copy link
Member Author

pirj commented Oct 22, 2020

All review notes applied ✔️

@pirj pirj requested a review from bquorning October 22, 2020 21:36
@pirj pirj mentioned this pull request Oct 27, 2020
9 tasks
@pirj pirj force-pushed the add-v2-migration-docs branch 2 times, most recently from cc41715 to 03e1a97 Compare November 3, 2020 20:03
@pirj
Copy link
Member Author

pirj commented Nov 3, 2020

@bquorning Ready for the review. There are changes since the last review, the list is in TODO section of the ticket description.
I've rearranged all the commits.

Copy link
Contributor

@sl4vr sl4vr left a comment

Choose a reason for hiding this comment

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

Just found a few inaccuracies.

docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
@pirj
Copy link
Member Author

pirj commented Nov 4, 2020

Eagle eye, @sl4vr, thanks a lot!

docs/modules/ROOT/pages/usage.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/usage.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/usage.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/usage.adoc Outdated Show resolved Hide resolved
- cop departments are nested for cops with a department that doesn’t match the extension name (`Capybara`, `FactoryBot`, `Rails`)
- `AllCops/RSpec/Patterns`/`AllCops/FactoryBot/Patterns` options are removed
- Calling `super` from `on_new_investigation` defined in a cop is mandatory now
- Avoid explicit definition of `cop` as `described_class.new`
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don’t understand this sentence. Could you explain a bit more, please?

docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/upgrade_to_version_2.adoc Outdated Show resolved Hide resolved
@pirj
Copy link
Member Author

pirj commented Nov 5, 2020

Suggestions applied, clarifications made, fixups pushed, later squashed. Thanks for the review, @bquorning !

@pirj
Copy link
Member Author

pirj commented Nov 5, 2020

edge-rubocop is back to green! 💚

@pirj pirj merged commit 38be753 into release-2.0 Nov 5, 2020
@pirj pirj deleted the add-v2-migration-docs branch November 5, 2020 09:08
@sl4vr sl4vr mentioned this pull request Nov 5, 2020
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants