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

Consistent linting and reformatting rules #24

Closed
pbugnion opened this issue Oct 22, 2018 · 4 comments
Closed

Consistent linting and reformatting rules #24

pbugnion opened this issue Oct 22, 2018 · 4 comments

Comments

@pbugnion
Copy link
Member

pbugnion commented Oct 22, 2018

I believe we have both been using black for formatting Python source code, and mostly sticking to pep 8. For now, the JS source code is mostly fairly self-consistent.

Would it make sense to adopt a consistent code style through reformatters and CI tests? It'd help outside contributors make pull requests that are visually similar to the current codebase. I suggest:

  • prettier for the JS, following dash-core-components. See this PR.
  • black and flake8 for the Python side and the docs, since they're (becoming) the de-facto standard.
  • enforcing consistency as part of the CI pipeline.

The timing around this needs to be somewhat well thought through to avoid merge conflicts with existing PRs.

Any thoughts?

@tcbegley
Copy link
Collaborator

I think this would be great.

Of the two currently open PRs, one is ready to merge and another doesn't affect any of the JS or Python source, so now might be a good opportunity to set something up?

@pbugnion
Copy link
Member Author

Great -- I'll add this over the next couple of days.

@tcbegley
Copy link
Collaborator

Perfect, let me know if I can help at all.

@pbugnion
Copy link
Member Author

pbugnion commented Nov 2, 2018

Closed by PRs #31 and #26 .

@pbugnion pbugnion closed this as completed Nov 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants