Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

67 lines (44 loc) · 2.49 KB
Raw

Contributing to Jalayan Vikram Robot

Thank you for your interest in contributing to the Jalayan Vikram Robot project! We welcome all contributions that will help improve this autonomous amphibious robot for disaster relief. Whether you’re fixing bugs, improving documentation, or proposing new features, we appreciate your efforts.

How to Contribute

  1. Fork the Repository
    Start by forking the repository to your own GitHub account.

  2. Clone Your Fork
    Clone the forked repository to your local machine:

    git clone https://github.com/your-username/Flood_robo.git
cd Flood_robo

  3. Create a New Branch
    Always create a new branch for your work. For example, if you're working on a new feature, create a branch called feature/new-feature:

    git checkout -b feature/new-feature

  4. Make Your Changes
    Make your changes to the code or documentation. Please ensure that your code follows our coding standards and is well-commented.

  5. Commit Your Changes
    Once you're happy with your changes, commit them:

    git add .
git commit -m "Description of your changes"

  6. Push Your Changes
    Push your changes to your forked repository:

    git push origin feature/new-feature

  7. Submit a Pull Request
    Go to the original repository and submit a pull request (PR). In the PR description, clearly explain your changes and reference any related issues.

Code of Conduct

We strive to create an inclusive and welcoming environment for everyone. By participating in this project, you agree to uphold our Code of Conduct. Be respectful, and communicate constructively.

Reporting Issues

If you encounter any bugs or have suggestions, please check the Issues section to see if it's already reported. If not, feel free to open a new issue with detailed information about the problem or suggestion.

Coding Standards

  • Code Quality: Ensure your code is clean and follows best practices.
  • Documentation: All functions, classes, and complex logic should be well-documented.
  • Testing: Please make sure your code has been tested and does not break any existing functionality.

Contributors

  • Jaswanth – Core Developer
  • Vishal – Robotics and Vision Specialist
  • Rohan Titus – Simulation and AI Integrator

Thank you for your time and effort. We look forward to your contributions!