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

Add a Code Style guide #34

Open
csala opened this issue Sep 16, 2019 · 3 comments
Open

Add a Code Style guide #34

csala opened this issue Sep 16, 2019 · 3 comments

Comments

@csala
Copy link
Contributor

csala commented Sep 16, 2019

Add a STYLE.md document with a detailed coding style guide and reference it from the CONTRIBUTING.md guide.

@micahjsmith
Copy link
Contributor

I think this is unnecessary, no? The cookiecutter should not be too opinionated on this, anything that conforms to pep8 should be acceptable

@csala
Copy link
Contributor Author

csala commented Sep 20, 2019

The idea is to try to have a consistent coding style across the different DAI-Lab projects.

So yes, actually being a bit more opinionated than pep8, and also include things that fall outsite its scope, like project structure, some generic best practices, docstrings and documentation format guidelines, etc.

But it would also not be something as detailed and rigid as the Google Python Style Guide, it would be something between the two.

@micahjsmith
Copy link
Contributor

This is simply too opinionated for a project template. Otherwise you and I will end up arguing about the contents of the STYLE file ad nauseam.

You should feel free to write up your style recommendations in a blog post or similar. If you are maintaining a project, you can request people review your preferred style. You are not the only user of the cookiecutter :)

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

No branches or pull requests

2 participants