The Gang Programming Guide

Lastest update Dec 15, 2020.

This document is incomplete, we recommend you recheck periodically.

At The Gang, we strive for quality maintainable code. As a software house, we handle and maintain many projects. The code written by our programmers need to be up to The Gang standard as it will eventually be handed over from person to person. This document will give you a heads up on what kind of code we expect.

Contents:

• Version Control
  • Basics
  • Main Branches
  • Branching Strategy
  • Merging Strategy
  • Code Review
• Python
  • Python Guideline
    • Variable Naming
    • Linting
    • Typing Annotation
    • Write Test
    • DocString
    • Return Object Instead of Long Tuple
    • Use Named Parameter
    • Class Constructor
    • Use Context Manager for Opening File
  • Flask
  • Data Analysis
    • Getting Started
    • Make Separate Folder for Each Member
    • Put your shared code in library
• Code Quality
  • SonarQube