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

Clarify dev workflow in CONTRIBUTING.md #1207

Merged
merged 1 commit into from
Aug 7, 2018
Merged

Conversation

jack-lewin
Copy link
Contributor

Explain that the test suite & linter run on built Enzyme;
Add guidance on dev workflow
@ljharb ljharb added the docs label Oct 2, 2017
CONTRIBUTING.md Outdated
@@ -62,10 +74,15 @@ npm run test:watch
This codebase adheres to the [Airbnb Styleguide](https://github.com/airbnb/javascript) and is
enforced using [ESLint](http://eslint.org/).

As with the test suite, linting rules apply to *built* Enzyme.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is maybe only partially correct. I believe the import/* eslint rules rely on built enzyme because they actually look at the filesystem and require that the built files be there, but linting doesn't actually run on the built files, they run on the src files... but they require the built files to be there. Kind of annoying that it works that way but hey, this is the babel-compiled world we live in...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point - I've added some clarification to that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants