Skip to content

Project Contribution Policies

This document outlines the standard contribution policies that ensure consistency, quality, and traceability across the project. All contributors are expected to follow these policies when committing code, opening issues, and collaborating on the codebase.

Commit Policies

Commit Message Format

All commit messages must follow the conventional format:

<type>(US-####): short description

[body]

[optional footer]

Example:

feat(US-1): add login routes

Add the Create, Update, Read and Delete routes for the login endpoint

Accepted Commit Types

  • feat: new feature
  • fix: bug fix
  • docs: changes to documentation
  • style: formatting, missing semi-colons, etc.
  • refactor: refactoring production code
  • test: adding or correcting tests
  • chore: updating build tasks, package manager configs, etc.

Commit Rules

  • Use the imperative mood (e.g., "add", not "added" or "adds").
  • Limit subject line to 50 characters.
  • Wrap body at 72 characters.

Code Policies

Structure and Organization

  • Maintain the agreed-upon project architecture.
  • Place files in appropriate directories (/src, /components, /services, etc.).
  • Avoid large functions or deeply nested logic — prefer modular, readable code.

Code Style

  • Follow the project’s linting and formatting rules.
  • Avoid commented-out code unless marked with TODO: or FIXME:.

Testing

  • All new features must include relevant unit or integration tests.
  • Tests should be named clearly and grouped by module.
  • Do not commit broken tests — CI must pass.

Security

  • Do not commit secrets, API keys, or credentials.

Revision History

Date Version Changes Author
2025-04-08 1.0 Initial version Mateus Vieira