Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 3.09 KB

CONTRIBUTION.md

File metadata and controls

73 lines (48 loc) · 3.09 KB

CONTRIBUTION.MD

Rules for commit messages and branch names to maintain consistency and readability in our project.

Branch Naming Conventions

All branch names must follow a consistent pattern to clearly indicate their purpose. Use the following prefixes:

  • feature/*: For new features. Example: feature/add-user-authentication
  • test/*: For testung a hypothesis. Example: test/will-it-work-or-wont
  • fix/*: For bug fixes. Example: fix/resolve-login-issue
  • refactor/*: For rewrite/restructure your code. Example: refactor/update-react-19
  • build/*: For changes in build components like build tool, ci pipeline, dependencies. Example: build/update-deploy-scripts
  • ops/*: For changes that affect operational components like infrastructure, deployment, backup, recovery. Example: ops/backup-utils
  • docs/*: For branches that affect documentation only. Example: docs/update-contrubution
  • security/*: For branches addressing security improvements or issues. Example: security/add-dotenv-secrets
  • chore/*: For tasks that don't directly affect the codebase (e.g., build process updates, dependency updates). Example: chore/update-dependencies

Invalid Branch Names:

Avoid vague or ambiguous branch names. Examples of invalid branch names:

  • my-branch
  • work-in-progress
  • bugfix

Commit Message Conventions

Commit messages should be clear, concise, and informative. They should follow the following format:

<type>(Optional: <scope>): <short description>

Where:

  • <type>: One of the following types:

    • feat: A new feature for the user.
    • fix: A bug fix for the user.
    • hotfix: A 🔥hot🔥 fix.
    • docs: Changes to the documentation.
    • style: Changes that don't affect the functionality (e.g., formatting, whitespace).
    • refactor: A code change that neither fixes a bug nor adds a feature.
    • test: Adding missing tests or refactoring existing tests.
    • build: Add command in build script.
    • security: Changes aimed at improving or resolving security-related issues.
    • chore: Changes to the build process or auxiliary tools and libraries.

  • <scope>: (Optional) A short description of the area of the codebase affected by the change. Example: auth, database, ui.

  • <short description>: A concise summary of the change (50 characters or less).

Example Commit Messages:

  • feat(auth): Add user authentication
  • fix(ui): Resolve button alignment issue
  • docs(readme): Update installation instructions
  • style: Fix formatting inconsistencies and eslint fixes
  • refactor(database): Improve database query performance
  • test(api): Add unit tests for API endpoints
  • security(env): Mask sensitive information in dotenv file
  • chore: Update Node.js version

Body (Optional):

For more complex changes, you can add a more detailed explanation in the body of the commit message. Leave a blank line between the short description and the body.

References

Conventional Commit Messages^