Skip to content

Latest commit

 

History

History
50 lines (29 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

50 lines (29 loc) · 1.83 KB

Contributing to AI-Based Sorting Robot Arm

Thank you for considering contributing to the AI-Based Sorting Robot Arm project! This document outlines the guidelines for contributing.

Getting Started

  1. Fork the repository.
  2. Clone your fork: https://github.com/elizabethmusanga/AI-SortingRobotArm.git
  3. Create a new branch for your feature or bug fix: git checkout -b my-feature-branch

Issues and Feature Requests

  • Feel free to open issues for bugs, enhancements, or new features related to the AI-Based Sorting Robot Arm.
  • Label issues appropriately (e.g., bug, enhancement, help-wanted).

Pull Request Process

  1. Ensure your code adheres to the coding standards.
  2. Associate your pull request with the relevant issue.
  3. Use a clear and concise title and description.
  4. Include unit tests if applicable.
  5. Update documentation as needed.

Coding Standards

Please follow the coding standards outlined in our Coding Style Guide.

Testing Guidelines

Before submitting a pull request, ensure that your code has been tested thoroughly. Include information on your testing approach in the pull request description.

Documentation

Update the documentation to reflect any code changes. If new features or changes are not documented, please include documentation updates in your pull request.

Review Process

All pull requests will be reviewed by our team. We appreciate your patience during this process.

License Agreement

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

Communication

If you have questions or need clarification, feel free to contact us.

Acknowledgment

We appreciate your contribution to the AI-Based Sorting Robot Arm project and recognize your efforts in our CONTRIBUTORS.md file.