Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

56 lines (39 loc) · 2.4 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project! This guide will help you get started with contributing to our codebase.

Branch Naming Convention

To keep our branches organized and easy to understand, please follow these naming conventions:

  1. Use lowercase letters: Use lowercase letters and separate words with hyphens (-) or slashes (/).

    • Example: feature/new-login-page, bugfix/fix-login-error

  2. Type/Description: Start the branch name with a type, followed by a brief description.

    • Types: feature, bugfix, hotfix, release, chore, refactor
    • Examples: feature/user-authentication, bugfix/null-pointer-exception

  3. Include task ID if applicable: If you are referencing a specific task or issue, include the task ID from your task management tool (e.g., GitHub Issues).

    • Examples: feature/1234-user-authentication, bugfix/5678-fix-login-error

  4. Keep branch names short: Avoid long descriptions to keep branch names concise.

    • Examples: feature/add-user-profile, bugfix/fix-login-button

  5. Prefix convention: For specific teams or projects, define prefix conventions if needed.

    • Examples: dev/feature-login, test/bugfix-authentication

  6. Release branches: Include the version number in release branches.

    • Examples: release/1.0.0, hotfix/1.0.1

  7. Avoid special characters: Do not use spaces, special characters, or non-ASCII characters in branch names.

Example branch names:

  • feature/add-user-profile
  • bugfix/fix-login-button
  • hotfix/urgent-payment-bug
  • release/2.0.0
  • chore/update-dependencies
  • refactor/improve-performance

Summary

  • feature: For developing new features.
  • bugfix: For fixing known bugs.
  • hotfix: For urgent fixes in the production environment.
  • release: For preparing a new release.
  • chore: For routine maintenance tasks.
  • refactor: For refactoring code without changing its external behavior.
  • test: For adding or modifying tests.

Other Guidelines

  • Commit Messages: Write clear and concise commit messages.
  • Code Reviews: All changes must be reviewed via pull requests.
  • Testing: Ensure your code passes all tests and adheres to the project's coding standards.

For more details, please refer to our Code of Conduct and Development Guide.

Thank you for contributing!