Skip to content

Latest commit

 

History

History
67 lines (50 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

67 lines (50 loc) · 1.78 KB

Contributing to Splitwise Clone API

Thank you for considering contributing to the Splitwise Clone API! To ensure a smooth contribution process, please follow these guidelines for branch naming and commit messages.

Branch Naming

  1. Feature Branches:

    • Naming Convention: feature/feature-name
    • Example: feature/user-authentication

  2. Bugfix Branches:

    • Naming Convention: bugfix/bug-description
    • Example: bugfix/fix-login-error

  3. Hotfix Branches:

    • Naming Convention: hotfix/hotfix-description
    • Example: hotfix/critical-security-patch

  4. Release Branches:

    • Naming Convention: release/release-name
    • Example: release/v1.0.0

Commit Messages

  1. Format:

    • Use the following format for commit messages: 
      [TYPE] Short description of the change

Longer description if necessary.
    • TYPE: The type of change (e.g., Feature, Fix, Refactor, Docs).

  2. Examples:

    • Feature: 
      Feature: Add user authentication

Implemented user authentication using JWT.
    • Fix: 
      Fix: Corrected login error

Fixed an issue where the login endpoint was returning a 500 error.
    • Refactor: 
      Refactor: Simplify user service

Refactored user service code for better readability and performance.
    • Docs: 
      Docs: Update README with setup instructions

Added detailed instructions for setting up the project.

Pull Requests

  • When creating a pull request, ensure it:
    • References any relevant issues or tickets.
    • Includes a clear description of the changes made.
    • Follows the branch naming and commit message guidelines.

Thank you for contributing!