Coding Standards - maar35/film-festival-planner GitHub Wiki

This will be much better in future. For now an agreement is covered concerning variable names.

C# Coding Standards

Concerns the Planner Project. Generally follow Microsoft's guidelines.

Variable names

  1. Variable names must be self explanatory
  2. Only exceptions are x and y (generally accepted as coordinate names), and w for width and h for height (agreed upon by the team)

C# Regions

Use these regions in this order:

  • Enumerations
  • Nested Classes
  • Constants
  • Private Variables
  • Properties
  • Calculated Propreties
  • Static Properties
  • Constructors
  • Override Methods
  • Virtual Methods
  • Interface Implementations
  • Public Methods
  • Private Methods
  • Custom Actions
  • Events

Python Coding Standards

Concerns the Loader Project.

Follow PEP 8 Style Guide.

Web Development Coding Standards

Concerns the (growing) part of the Planner that is being rewritten in Django.

Provisional rules

  • Use one single base template for all pages in a project
  • Put all static styling in CSS
  • Always have a unique title in the HTML Header
  • Always have a style class error with a horribly outstanding color scheme
  • Use <p3> for page headers
    • Sentence case
    • No terminating point punctuation mark

Bash Coding Standards

Concerns the Loader Project.

Follow Google Bash Style Guide.

General naming agreements

combination program vs compilation program

Use combination since the term should in the end include pre-film + main film combinations and combinations of e.g. multiple short films in one main program. The use of compilation is allowed when distinction between the above two cases is needed.