search

DAI-Lab / cookiecutter-pypackage

DAI Lab's adaptation of cookiecutter-pypackage
BSD 3-Clause "New" or "Revised" License
1 stars 5 forks source link

Add a Code Style guide #34

Open csala opened 4 years ago

csala commented 4 years ago

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

micahjsmith commented 4 years ago

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

csala commented 4 years ago

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 commented 4 years ago

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 :)