Skip to content

Latest commit

 

History

History
93 lines (60 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

93 lines (60 loc) · 2.61 KB
Raw

Contributing to Computer Vision Projects

Thank you for considering contributing to the Computer Vision Projects repository! Contributions are welcome from everyone. By contributing, you help improve the quality of this repository and make it more useful for others. Please take a moment to review these guidelines before submitting your pull request.

🚀 Getting Started

1. Fork the Repository

First, fork the repository to your GitHub account by clicking the "Fork" button on the top-right corner of the repository page.

2. Clone the Repository

Clone the forked repository to your local machine using the following command:

git clone https://github.com/your-username/Computer-Vision-Projects.git

3. Navigate to the Project Directory

Change your directory to the project folder:

cd Computer-Vision-Projects

4. Install Dependencies

Install the required dependencies using pip:

pip install -r requirements.txt

5. Create a Branch

Create a new branch for your feature or bug fix:

git checkout -b feature-branch

💻 Coding Standards

To maintain consistency across the project, please follow these coding standards:

  • Follow PEP 8: All Python code should follow the PEP 8 style guide.
  • Use meaningful commit messages: Clearly explain the changes in your commit messages.
  • Test your code: Ensure that your code works as expected before submitting a pull request.
  • Comment your code: Include comments for better readability and maintainability.

🤝 How to Submit a Pull Request

  1. Make your changes on your branch.
  2. Commit your changes with a clear and concise message: 
    git commit -m "Add a brief description of your change"
  3. Push to your branch: 
    git push origin feature-branch
  4. Submit a Pull Request:
    • Go to your forked repository on GitHub.
    • Click the "Compare & pull request" button.
    • Provide a detailed description of your changes in the pull request.
    • Link to any relevant issue numbers if applicable.

🔧 Reporting Issues

If you find any bugs or issues, feel free to open an issue with the following details:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Screenshots or code snippets if applicable.

📜 License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for your interest in contributing to the Computer Vision Projects repository!