Code review guidelines

Work in progress

At a minimum, code in Iris must meet these standards.

• Code is submitted in proper branch or it does not get reviewed (or landed)
  • All code has an open Git issue associated with it
  • Code is in a branch named after the issue
  • Branch name includes only 'issue' and issue number, and possibly underscores
    • 'issue500'
    • 'issue_500'
    • 'issue_500_501'
  • No other characters allowed in branch name
• PEP 8 check
  • Run analysis in PyCharm
  • One blank line at end of file
  • Imports
    • Alphabetized
    • No unused libraries
    • Avoid wildcard import when possible, except our own modules (core.py)
• Good grammar/punctuation/spelling
  • Comments, logger messages, and assert messages are complete sentences
  • Sentences begin with capitalization
  • Sentences end in periods
• Patterns
  • Check for duplicate patterns
  • Patterns are named intuitively
  • File names are alphanumeric, lowercase, with or without underscores - no other characters
• Must pass on all three platforms before landing
  • Developer does this
  • Reviewer does the same whenever possible
• Only work referenced in the Git issue(s) can be included - no other changes