Skip to content

Coding Standards

Jesse edited this page Nov 22, 2025 · 8 revisions

Coding Standards

This page outlines the core coding standards used across all practicum projects.
These standards ensure consistency, readability, and professionalism in student code β€” regardless of programming language or IDE.
Each section provides clear guidelines, examples, and tools that help you write clean, maintainable code.

Use the links below to navigate to specific subpages.


Quick Navigation


Language-Specific Standards

Below are the available coding standards for each supported language.
Each link includes detailed conventions, examples, and best practices.

JavaScript / TypeScript

Page: Coding-Standards-JS-TS
Covers ES module syntax, variable naming, async/await rules, TypeScript typing guidelines, React/Expo conventions, and more.

Python

Page: Coding-Standards-Python
Includes PEP 8 conventions, docstrings, indentation rules, environment best practices, and module organization.

SQL

Page: Coding-Standards-SQL
Focuses on query structure, uppercase keywords, indentation, JOIN formatting, and view/procedure standards.

Additional Languages

Page: Coding-Standards-Additional
Optional page for any language used in specialty tracks or projects.


Linting & Formatting

Proper linting and formatting helps ensure code consistency across the team.
These rules are enforced in most projects and must be followed before submitting a pull request.

Prettier Rules

Page: Coding-Standards-Prettier
Explains the shared Prettier config, formatting standards, and how to auto-format code on save.

ESLint Conventions

Page: Coding-Standards-ESLint
Documents required ESLint rules, common error types, and how to resolve them.

Auto-Formatting Code

Page: Coding-Standards-Autoformatting
Walks students through configuring their IDE to automatically format code on save (VS Code, WebStorm, Android Studio).

File & Folder Naming Standards

Page: Coding-Standards-Naming
Names must be readable, predictable, and consistent across all repos. This page outlines rules for casing, file structure, and naming conventions.


If you are unsure which standards apply to your project, ask your instructor or refer to the project’s README.

Clone this wiki locally