-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Add note directing to pretest #1040
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
Conversation
Ah good point, |
@@ -1,6 +1,6 @@ | |||
# plotly.js image testing | |||
|
|||
Test plotly.js with Plotly's image testing docker container. | |||
Test plotly.js with Plotly's image testing docker container. Before starting, don't forget to [set up your testing environment with `npm run pretest`](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md#development). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would put this new line under
as pretest
has nothing to do with docker.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great, that's what I was wondering. So is correct usage right below the 'IMPORTANT' section as a "before you do any of these other things" command?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd vote for putting it above the IMPORTANT.
Mentioning pretest
should be a reminder as opposed to an important comment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nicely done 💃 |
Added to the first line of the image test instructions:
I could make this Step 0. Or Step 1. Or Step 1.5. Glad to amend, but I think it's worth mentioning on this page since the tests don't work without it. Wasn't strictly sure where in the sequence it had to go.