-
Notifications
You must be signed in to change notification settings - Fork 4
Language Specific Standards
Consistent coding standards help ensure that every team member writes clear, maintainable, and predictable code β regardless of language or IDE.
These guidelines give you a solid foundation of best practices, while separate subpages contain deeper explanations, examples, and project-specific requirements.
Use the sections below to learn the expectations for each language used in the practicum.
View General Coding Standards Overview
Regardless of language, our coding standards focus on:
- Write code for humans first, compilers second
- Favor clarity over clever tricks
- Keep line lengths reasonable and indentation consistent
- Use meaningful names
- Keep functions and classes small
- Follow consistent patterns across files and folders
- Use the same structure other developers expect
- Follow naming conventions (
camelCase,snake_case,PascalCase) - Avoid reinventing patterns your project or community already solved
- Prettier for auto-formatting
- ESLint for JavaScript/TypeScript
- Pylint/Black for Python (if applicable)
- SQL capitalization and indentation conventions
- Write comments that explain WHY, not WHAT
- Use docstrings (Python) or JSDoc/TSdoc for JS/TS
- Comment complex queries in SQL
These principles apply to all languages across the practicum.
View JavaScript / TypeScript Standards
JavaScript and TypeScript are used across many practicum projects:
web apps, mobile apps (Expo), APIs, and class assignments.
- Use ES Modules (
import/export) - Prefer
constandletinstead ofvar - Use arrow functions for inline and callback code
- Enforce consistent typing in TypeScript
- Use
async/awaitinstead of.then() - Keep React/Expo components small and readable
- Organize code by feature or module
-
camelCasefor variables and functions -
PascalCasefor components and classes -
SCREAMING_SNAKE_CASEfor global constants
- ESLint
- Prettier
- TypeScript compiler diagnostics
View Python Standards
Python is used for scripting, automation, data science, and backend components.
- Follow PEP 8 style guidelines
- Use 4-space indentation
- Use snake_case for variables and functions
- Use PascalCase for classes
- Add docstrings using triple quotes
- Keep modules focused and short
- Use type hints (
def add(x: int, y: int) -> int:)
Always create a virtual environment:
<bash> python -m venv venv <>
View SQL Standards
SQL is used in data-related assignments, backend services, and analysis tasks.
- Use UPPERCASE for SQL keywords (SELECT, JOIN, WHERE)
- One clause per line for readability
- Use table aliases (short, meaningful)
- Prefer CTEs (
WITHstatements) for complex queries - Avoid SELECT * unless exploring or debugging
- Indent subqueries consistently
WITH active_users AS (
SELECT id, name
FROM users
WHERE status = 'active'
)
SELECT *
FROM active_users
ORDER BY name;- snake_case for table and column names
- avoid spaces or uppercase identifiers
View Additional Languages Standards
Some practicum tracks or elective projects may use additional languages such as:
- Java / Kotlin (Android development)
- Swift (iOS prototype work)
- C# (Unity or desktop tooling)
- Go (backend microservices)
- C++ (systems or performance-based modules)
For each language, you should document:
- Structure of files and folders
- Naming conventions
- Indentation style
- Common patterns or frameworks used
- Required tools (linters, formatters, compilers)
- Sample code formatting
- Any project-specific rules established by the team
Home β’ New Student Onboarding β’ Guides β’ Projects β’ Code of Conduct β’ FAQ
Last updated: 12/7/2025