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

Codebase needs a style guide #874

Open
ejochman opened this issue Apr 2, 2019 · 2 comments
Open

Codebase needs a style guide #874

ejochman opened this issue Apr 2, 2019 · 2 comments

Comments

@ejochman
Copy link
Contributor

ejochman commented Apr 2, 2019

There are a couple issues open right now that suggest a general restructuring of GAM code, which I agree would be good. However, one simple fix that would help both with code structure and readability of contributed code is a style guide that could be enforced during PR review.

The main file is over 13k lines, at this point, and lacks a consistent style and structure throughout, making it difficult for new contributors to even find their footing. There are several existing published style guides that could be utilized. I'm a bit biased, but I believe Google's published Python style guide is generally popular amongst different organizations. That said, I'd be happy with just about any choice at this point, as long as it improves the consistency.

Some examples of readability issues in current code:

  • Lack of docstrings on most methods
  • camelCase and snake_case inconsistency across variables and method declarations
  • Really long character line limits causing horizontal scroll to be necessary, even on large displays
  • Line break indentation inconsistency
@stale
Copy link

stale bot commented Mar 5, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the wontfix label Mar 5, 2020
@stale stale bot closed this as completed Mar 12, 2020
@ejochman
Copy link
Contributor Author

Reopening as a lingering issue

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

2 participants