GAM-team / GAM-team/GAM

Codebase needs a style guide

Open
#874 2 comments 2 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
4.3k
Forks
537
Avg merge
2h 34m
Merged PRs (30d)
9

Description

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](http://google.github.io/styleguide/pyguide.html) 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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.