Code Clean Up Guide

Overview

This document covers the type of work that should be performed when doing final code cleanup for a change. This work should not be performed unless the user explicitly asks for a "code clean up" step at the end of a coding session.

Preparation

• Start by running git diff to see what changes were introduced
• Focus cleanup only on files/lines that appear in the diff

General Rules

• Do not modify any code that wasn't introduced by the unstaged changes.
• Try to match existing styles you see in the code near the change that was introduced.
• Do not alter the behavior of the existing code
• Don't worry about markdown files.
• Refactorings should leave the code in an easier to understand and more maintainable state.
• You should use short and meaningful code comments.