Skip to content

Latest commit

 

History

History
10 lines (9 loc) · 627 Bytes

Commit_Conventions.md

File metadata and controls

10 lines (9 loc) · 627 Bytes

Format For File Commits:

  • Decriptive file name that references what the code does
  • Extended decription should include what function/purpose the code serves, whether it works or not, and any additional things to add
  • Use common sense for names and descriptions; specific problems in the code can be referenced in the description and further explained with #commments and """ Multi-line ... comments """ in the code itself

Naming Conventions:

  • joined_lower for attributes, variables, parameters
  • joined_lower or ALL_CAPS for constants
  • StudlyCaps for classes
  • camelCase to functions, methods