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

Reorganize README & CONTRIBUTING and add testing docs #350

Merged
merged 3 commits into from
Dec 19, 2018

Conversation

dferber90
Copy link
Contributor

@dferber90 dferber90 commented Dec 18, 2018

This PR reorganises the README by moving less relevant sections out to CONTRIBUTING or collapsing them behind a details component.

This PR also adds a new Testing section which explains the differences between our testing approaches and the decisions made there.

I've had this PR sitting for a while but wanted to wait until we've got Visual Regression Testing up and running.

Copy link
Member

@emmenko emmenko left a comment

Choose a reason for hiding this comment

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

Nice, looks good to me! 💯

I left a couple of suggestions to improve the wording

Copy link
Contributor

@montezume montezume left a comment

Choose a reason for hiding this comment

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

Looks good. I can push the english nitpick fixes if you like

@dferber90 dferber90 merged commit 1891509 into master Dec 19, 2018
@dferber90 dferber90 deleted the df-add-testing-docs branch December 19, 2018 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants