Skip to content

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

Merged
merged 2 commits into from
Oct 14, 2016
Merged

Add note directing to pretest #1040

merged 2 commits into from
Oct 14, 2016

Conversation

rreusser
Copy link
Contributor

@rreusser rreusser commented Oct 14, 2016

Added to the first line of the image test instructions:

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.

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.

@etpinard
Copy link
Contributor

Ah good point, pretest is mentioned in the CONTRIBUTING file here, but yeah might as well mention in the image test README too. 👍

@@ -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).
Copy link
Contributor

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

https://github.com/plotly/plotly.js/blob/master/test/image/README.md#step-2-run-the-image-tests

as pretest has nothing to do with docker.

Copy link
Contributor Author

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?

Copy link
Contributor

@etpinard etpinard Oct 14, 2016

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Modified:

screen shot 2016-10-14 at 11 19 30

@etpinard
Copy link
Contributor

Nicely done 💃

@rreusser rreusser merged commit 6b2c16a into master Oct 14, 2016
@rreusser rreusser deleted the add-pretest-instructions branch October 14, 2016 19:49
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.

2 participants