Pull Request Standard

When you post a Pull Request, write it as if you were defending your choices in court.

General workflow

Before merging new code into production branches, we need to test it and validate it with multiple eyes. We do this by bringing up code in a new branch, and proposing it in a Pull Request for others to see, and then merge.

Purpose

Pull Requests are a clean, safe way to introduce new code into production branches of a project. Pull Requests provide various benchmarks for double-checking code that include:

• Unit tests
• Formatting Scans (see Clean Code Standard)
• Peer reviews and constructive feedback

Reviewee Responsibilities

You should... [add more here]

Title

The title should follow this format:

[Jira Ticket]: [Short and descriptive title]

Example

RMSW-14: Implementation of Digital Sensors

Initial Comment

A brief, descriptive comment that addresses the following criteria:

• Goals of the PR
• Unit tests to run for validation
• Any important notes

Example Moved wheel speed sensor into digital sen> sors.

• Added calculations for wheel speed.
• Added test for wheel speed which all pass.
• Added ESC digital sensor that indicates if the ESC is alive or not.
• Removed wheel flux sensor.

To run test: make tests/WheelSpeedTest.out && ./tests/WheelSpeedTest.out

NOTE: other sensors may not work

Reviewer Responsibilities

add more here