Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 2.05 KB
Raw

CvFy Contribution Guidelines

Thank you for considering contributing to CvFy! We welcome all contributions that help improve the project and make it better for everyone. Please take a moment to review these guidelines before getting started.

Intro

We welcome various types of contributions, including: bug fixes, feature enhancements, documentation improvements and writing tests.

We use GitHub Flow for managing contributions to the project. This workflow involves the following steps:

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch with a descriptive name for each feature or bug fix.
  4. Make your changes.
  5. Commit your changes and push them to the branch on your forked repository.
  6. Open a pull request (PR) to the main branch of the original repository.
  7. Discuss and review the changes with the project maintainers.
  8. Make any necessary updates based on the feedback received.
  9. Once approved, your changes will be merged into the main branch.

Getting started

To contribute to CvFy, please follow these steps:

  1. Fork the CvFy repository to your GitHub account.
  2. Clone your forked repository to your local machine: git clone https://github.com/<your-username>/cvfy.git
  3. Install the project dependencies as described in the project's README file.

Submitting a Pull Request (PR)

Before submitting a pull request, make sure to:

  • Break down the PR in to smaller ones if it contains multiple or unrelated features/fixes that can be done independently.
  • Update the project documentation if necessary.
  • Write clear and concise commit messages.
  • Try following the coding style and conventions used in the project.
  • Ensure all tests pass.

When submitting a PR, provide a comprehensive description of the changes and the rationale behind them. This will help with the review process.

Contact

If you have any questions or need any further assistance, you can reach out to claudiabdm.