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

Closes #173: Add Python Guidelines #177

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

joeriddles
Copy link
Contributor

Work in progress.

@joeriddles
Copy link
Contributor Author

joeriddles commented May 7, 2021

@joeriddles
Copy link
Contributor Author

joeriddles commented Jun 16, 2021

Notes from Coding Standard review 6/16/21

Categories of standards:

  • Stylistic
  • Related to performance

Philosophy of coding guidelines (Kelly)

  1. Readability <-- lowers conceptual load, especially moving between projects/languages
  2. Uniformity / predictability <-- " "
  3. Pit of success <-- "If you always do it this way, you'll avoid a lot of issues"
  • "Why", not just "what" (Kevin)

How opinionated do we get?

  • AVOID vs. DO NOT (Mark)
  • "We are not going to take a stance on this ___"
    • We don't need to take an opinion on this
    • When do we need to be firm on something that's stylistic vs. not

CONSIDER: use when there's an exception
DO: when there's not an exception

@joeriddles
Copy link
Contributor Author

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

Successfully merging this pull request may close these issues.

1 participant