Skip to content
This repository was archived by the owner on Jan 5, 2026. It is now read-only.

Team Coding Standards

Jump to bottom
Caroline Cahilly edited this page Mar 3, 2025 · 4 revisions

Team Coding Standards

Syntax

  • Everyone uses flake8 as a linter to assure common syntax practices and to improve overall code robustness
  • Note: It is highly recommended you use some linter. Flake8 is a popular python one
  • Favor top of page comments over inline comments

Function and Variable Naming

snake_case

API naming conventions

/action type/specific action; e.g., /delete/remove_user

Data Formats

Data will be passed in JSON format whenever possible according to the following conventions…

Pull Requests

Branching

Any new branch should be titled as: /username/workarea. For example, /jay/pose-estimation

Commits

The commit description should make it clear to a reviewer what the commit accomplishes. Incremental commits are encouraged as opposed to one giant commit; however if your commit is large or is particularly complex, your commit description should call that out.

PR and PR Reviews

For any work to be merged into main it must go in as a pull request (PR) and must be reviewed by at least one other member of the team. Please take time in the comments associated with your pull request to detail the changes and describe how a reviewer can test for expected functionality.

Anybody on the team should be free to tag anyone else as a reviewer.

If you have been tagged as a reviewer, you will make every effort to complete a review within 24 hours.

Clone this wiki locally