Skip to content

Latest commit

 

History

History
70 lines (40 loc) · 2.3 KB

CONTRIBUTIONS.md

File metadata and controls

70 lines (40 loc) · 2.3 KB

Contributing Guidelines

Welcome to the project! We're thrilled to have you here. To contribute, follow these guidelines to ensure a smooth and effective collaboration.

Getting Started

  • Fork this repository by clicking on the "Fork" button on the top right of this page. This will create a copy of the repository under your GitHub account.

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

git clone https://github.com/arindal1/yolov5-onnx-object-recognition.git
  • Create a new branch to work on your contribution:
git checkout -b feature/your-feature

  • Replace your-feature with an appropriate name for your feature or fix.

  • Make your changes to the codebase. Ensure you follow the project's coding standards and guidelines.

  • If you're participating in Hacktober 2023, please follow Hacktober's PR Guidelines.

  • Commit your changes with a descriptive commit message:

git commit -m "Add your descriptive commit message here"
  • Push your changes to your forked repository:
git push origin feature/your-feature

Contribution Rules

  • Make sure to sync your forked repo with the master repo to make sure there are no conflicts.

  • Don't delete/change someone else's contribution, unless absolutely necessary. Explain your changes properly.

  • Format your PR Description properly. Follow PULL_REQUEST_TEMPLATE.

  • After adding your contributions, add your Info in CONTRIBUTORS.js.

  • You can also add your Github avartar in README.md's Contributors section.

Submitting a Pull Request

Once you've pushed your changes, go to your forked repository on GitHub and click on the "New Pull Request" button. Fill in the necessary details and submit your pull request.
Also, reemeber to format your PR properly.

Code Style and Guidelines

Adhere to the project's and Hacktober's coding style and guidelines and the above Contribution Rules.

Testing

Ensure that your contributions are properly tested. If the project has existing tests, run them to confirm that your changes haven't broken anything.

Structure

For a proper PR Structure please refer PULL_REQUEST_TEMPLATE.

Thank you for contributing!