Team Best Practices

[ryanlong1004]

Living document to start capturing what our best practices are.

1. PEP 8 compliant (black)
2. Code documentation style -> numpy?
3. Minimum code coverage -> ?

Linting

1. 100% pass -> Yes
2. Adding exceptions to lint rules -> few way to do this ?
3. Ignored rules -> ?

Some rules we may choose to completely ignore, on package, module, file, or line basis. For example.

• Too many arguments (17/5) (too-many-arguments)
• Too many local variables (17/15) (too-many-locals)

Versioning

1. Semantic

Code Documentation

1. public facing attributes - full numpy docs
2. private attributes - as needed if the code does not convey the process

Allowed?

1. Relative imports?
2. Data classes ( Python > 3.7 )

Commit Message Format & Branching

• This is already well defined https://github.com/NOAA-EMC/global-workflow/wiki/Development-of-Global-Workflow)