Skip to content

Cygnus Coding Standards

Welcome to the Cygnus Dynamics Coding Standards — the single source of truth for how we write code across all our technology teams.

Who is this for?

Every engineer at Cygnus Dynamics is expected to read and follow these standards. They apply to all production code and are enforced during code review.

Purpose of having Coding Standards

Coding standards play a crucial role in software development. Here’s why having coding standards matters:

  • Consistency: Coding standards ensure uniformity across codebases, making it easier for developers to read, understand, and maintain code.

  • Readability: Well-defined standards enhance code readability, reducing errors and improving collaboration.

  • Error Prevention: Consistent practices help catch common mistakes early, preventing bugs and improving code quality.

  • Scalability: Adhering to standards ensures code can scale without becoming unwieldy or unmanageable.

  • Cross-Team Collaboration: Shared standards facilitate collaboration among developers, even in large teams.

  • Code Reviews: Standards provide clear criteria for code reviews, leading to more effective feedback.

  • Efficient Maintenance: Following standards simplifies debugging, refactoring, and maintenance tasks.

What's Covered

Section Description
General Principles Universal rules that apply to all languages
Java Back-end services coding standards
React Front-end application coding standards
Node.js API and middleware coding standards
Git & Code Review Commit messages, branch naming, and PR guidelines

How Standards Are Enforced

  • Code reviewers are expected to flag violations
  • PRs that fail code review checks will not be merged
  • Repeated violations will be raised with your Tech Lead

Questions or suggestions?

Raise it in #coding-standards on Slack or speak to your Tech Lead.