chore: make spec migration screen text more generic #22325
Conversation
|
Thanks for taking the time to open a PR!
|
|
Test summary
Run details
View run in Cypress Dashboard ➡️ FlakinessThis comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard |
| @@ -543,7 +543,7 @@ | |||
| "after": "After", | |||
| "heresWhy": "here's why:", | |||
| "renameAuto": { | |||
| "title": "We recommend automatically renaming your specs in this step", | |||
| "title": "We recommend automatically updating your specs in this step", | |||
There was a problem hiding this comment.
"updating" sounds to broad to me, what we recommend is definitely renaming. This title probably doesn't need a change.
There was a problem hiding this comment.
Good point, reverted
| @@ -598,7 +598,7 @@ | |||
| "description": "Complete the steps below to migrate your project to Cypress 10", | |||
| "step1": { | |||
| "title": "Rename existing specs", | |||
| "description": "In this step, we'll automatically rename and move your existing spec files.", | |||
| "description": "In this step, we'll automatically change existing spec files to match the new convention.", | |||
There was a problem hiding this comment.
This also seems too broad compared to what we have now. How about:
In this step, we'll automatically rename and/or move your existing spec files as needed.
Which keeps the scope narrow to what we will actually do, and allows it to be correct even if we are only doing one thing or the other. We could leave all other text the same I think.
There was a problem hiding this comment.
I actually had some variation of this but ended up flip flopping back to "update", but happy to go with this.
| @@ -598,7 +598,7 @@ | |||
| "description": "Complete the steps below to migrate your project to Cypress 10", | |||
| "step1": { | |||
| "title": "Rename existing specs", | |||
There was a problem hiding this comment.
In the screenshot, this title is changed, but it's not here?
There was a problem hiding this comment.
Oops, I might have missed a commit.
There was a problem hiding this comment.
Oh, let's use "Migrate existing specs" for the title. It's the perfect description for what we are doing, it's the migration UI, after all.
There was a problem hiding this comment.
Done!
I also updated the screenshot.
| "title": "Rename existing specs", | ||
| "description": "In this step, we'll automatically rename and move your existing spec files.", | ||
| "title": "Migrate existing specs", | ||
| "description": "In this step, we'll automatically rename and/or move your existing spec files as needed.", |
There was a problem hiding this comment.
Simpler version, up to you!
| "description": "In this step, we'll automatically rename and/or move your existing spec files as needed.", | |
| "description": "In this step, we'll automatically update your existing spec file paths.", |
There was a problem hiding this comment.
Hahaha just caught up on the whole thread on wording between you and @marktnoonan . My 2 cents is that rename and/or move is a bit wordy and makes me think, whereas "update" covers both and I don't have to cerebrally digest what's happening. It's a simple thing we're doing, imo the markup should be short & sweet
There was a problem hiding this comment.
When I read "update" I feel like like it could do absolutely anything to my files. It's not clear that the changes are limited to moving/renaming, that in this step we aren't going to actually touch the internals of files (like we do other places).
There was a problem hiding this comment.
What if it's "update your existing spec file paths" instead of "update your existing spec files"?
fwiw I'm not married to either approach and will support whatever you choose 😃
There was a problem hiding this comment.
I'm happy with either, just gonna ship this as is. I think they are both fine and combined with the UI, it's pretty clear what's going on.
* chore: make spec migration screen text more generic * update language
User facing changelog
N/A
Additional details
Make the text more generic, as to cover all the cases where we automatically change specs:
Steps to test
Just open launchpad to any Cypress 9 project and have a look.
How has the user experience changed?
Improved language in migration UI to be more clear about intended and recommended behavior.
Before
After
PR Tasks
cypress-documentation?type definitions?