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

Language guides vs. templates #265

Closed
egpbos opened this issue Apr 7, 2022 · 1 comment
Closed

Language guides vs. templates #265

egpbos opened this issue Apr 7, 2022 · 1 comment

Comments

@egpbos
Copy link
Member

egpbos commented Apr 7, 2022

While discussing #260, I realized that we're duplicating language documentation between the Python language chapter and our Python template. For instance, I recently added tox support there, including explanation of why tox is a good alternative to just vanilla pytest. It feels foolish to have to add it here as well.

This got me thinking: isn't having templates a better, more active and constructive way to convey our best practices anyway? Shouldn't we simply convert all information in the language chapters into directly practically applicable templates? And then just keep those up to date.

@c-martinez
Copy link
Member

Hey @egpbos -- I agree we should not duplicate efforts, but just having our best practices shared in the templates implies that we always create a new project (so we exclude out all existing software from being able to improve).

I think it might be a better approach to NOT include the reasoning in the template, but rather point to the guide (or The Turing Way if suitable).

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

3 participants