https://github.com/astrocatalogs/astrocats
Tip revision: 2c59925442262427920f5cdeb7b822bc17ac6f0b authored by lzkelley on 28 June 2018, 01:13:45 UTC
DOCS: new to-do item
DOCS: new to-do item
Tip revision: 2c59925
DEVELOP.md
# AstroCats Development README #
## Structure and Code Style ##
Unless otherwise noted, everything should be
[PEP8](https://www.python.org/dev/peps/pep-0008) compliant, with 79 characters
maximum per line (we ignore the 72 character docstring maximum). Please make
variable names descriptive, and add comments describing *everything*. Avoid
the use of literals whenever possible - using/defining/documenting constants
appropriately.
## Naming Conventions ##
- Directories: `lowercase`,
- Files: `lowercase`
- Classes: `TitleCase`
- Variables: `lower_case` (i.e. underscores for breaks/spaces)
- Constants: `UPPER_CASE`