Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (51 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

66 lines (51 loc) · 2.08 KB

Contributing to QuickCv

Thank you for considering contributing to QuickCv! We appreciate your help in making this project better. Below are the guidelines for contributing to this project.

How to Contribute

  1. Fork the repository

    • Fork the QuickCv repository to your GitHub account.

  2. Clone your forked repository

    • Clone the repository to your local machine: 
      git clone https://github.com/codad5/quickcv.git

  3. Create a new branch for your changes

    • Name your branch descriptively (e.g., fix-validation-error, add-new-feature): 
      git checkout -b your-branch-name

  4. Make your changes

    • Ensure that your changes are well-structured and follow the coding standards of the project.

  5. Commit your changes

    • Write clear, meaningful commit messages in the following format: 
      [change-type]: your message
      Example: 
      [feat]: added certificate field in the resume generator
      • Change types:
        • feat : For new features
        • fix : For bug fixes
        • docs : For documentation updates
        • style : For formatting changes
        • refactor : Code changes that neither fix a bug nor add a feature
        • test : Adding or updating tests
        • chore : Maintenance tasks, such as updating dependencies

  6. Push to your forked repository

    • Push your changes: 
      git push origin your-branch-name

  7. Submit a pull request

    • Open a pull request from your forked repository to the main repository.

  8. Wait for a review

    • We will review your pull request and may request changes. Please be patient as we get to your submission.

Reporting Issues

  • If you find any bugs or have feature requests, please open an issue on GitHub.
  • Make sure the issue hasn't already been reported by searching through existing issues.

Coding Standards

  • Follow the existing style of the codebase.
  • Use meaningful variable and function names.
  • Keep the code clean and organized.

Thank you for contributing!