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

Include a style guide for contributors #47

Closed
diracdeltas opened this issue Oct 9, 2013 · 2 comments
Closed

Include a style guide for contributors #47

diracdeltas opened this issue Oct 9, 2013 · 2 comments

Comments

@diracdeltas
Copy link
Contributor

We should have consistent coding styles.

@diracdeltas
Copy link
Contributor Author

We still aren't really PEP8 compliant. Should this be a goal?

I use https://github.com/klen/python-mode with

au FileType python setlocal tabstop=8 expandtab shiftwidth=4 softtabstop=4        
let g:pymode_lint = 1                                       
let g:pymode_lint_checker = "pyflakes,pep8"

@garrettr
Copy link
Contributor

This is still an issue. We've had several pull requests come through recently that have fixed a number of PEP8 violations, which has helped. I think we should re-orient this issue to not only recommend a consistent coding style, but to enforce it. Therefore, the requirements for this issue should be:

  • Make coding style adherence a requirement for contribution, and document the requirement in our contribution guidelines (docs/develop.md).
  • Enforce this requirement via our CI pipeline. For example, Let's Encrypt checks code style as part of their Travis automated tests.

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

No branches or pull requests

4 participants