Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.8 KB

CONTRIBUTION.md

File metadata and controls

45 lines (31 loc) · 1.8 KB

Contributing to Job Leet

Thank you for considering contributing to Job Leet! We’re excited to have you help improve the project. To ensure that contributions are smooth and effective, please follow these guidelines:

Steps to Contribute:

  1. Fork the Repository: Start by creating your own fork of the repository to work on.

  2. Create a New Branch: Always create a new branch for each feature or bug fix. Name your branch according to the following convention:

    git checkout -b feat/your-name/issue-number

    Example:

    git checkout -b feat/johndoe/42

  3. Make Your Changes: Implement your changes, keeping the following guidelines in mind:

    Branch Naming Convention:

    • Create branches from the main branch.
    • Use the format: feat/your-name/issue-number for new features or fix/your-name/issue-number for bug fixes.

  4. Commit Your Changes: Write clear and concise commit messages, following Conventional Commit Standards.

    Example commit message:

    git commit -m "feat: Add search functionality for job seekers #42"

    For bug fixes:

    git commit -m "fix: Handle 404 errors for job search API #21"

  5. Testing: Ensure all new functionality is properly tested. Write tests for new features and bug fixes, and ensure existing tests continue to pass.

  6. Code Quality: Before pushing your changes, make sure to:

    • Follow clean code principles.
    • Refactor when necessary to keep the codebase maintainable and efficient.

Reporting Issues:

If you encounter any issues or have suggestions for improvements, please open an issue here and provide clear details about the problem or enhancement.