Conventions

There are nearly infinite ways to program the same thing, but some ways will get your PR rejected.

In this category you’ll learn all about the coding conventions we have chosen for the codebase, which you’ll need to follow if you want to get your PR merged.

See Codebase Organization for guidelines on how files and folders are organized in the SS14 codebase.

Read the Pull Request guidelines to learn how to make your code more reviewable by maintainers.

Info

Keep in mind that some older areas of the codebase might not follow these conventions. These should be refactored in the future to follow them. All new code should try to follow these conventions as closely as possible.

Navigation

This is the recommended order to read these conventions for the first time.

  1. General programming
  2. Project programming
  3. ECS Conventions
  4. Architecture
  5. Networking Conventions
  6. Resource Conventions
  7. Module Conventions

Subpages