CONTRIBUTE

Contributing to Zeroth Robotics

Please contribute to https://github.com/zeroth-robotics! We welcome contributions from everyone, whether you’re a seasoned robotics engineer or just starting out. Here’s how you can get involved:

How to Contribute

We welcome contributions in many forms, including:

  • Bug Reports: Found a bug? Let us know!
  • Feature Requests: Have an idea for improvement? Share it!
  • Documentation: Help us make our documentation better for everyone.
  • Code Contributions: Want to improve the code? We’d love to see it.

To get started, please follow these steps:

Fork the Repository

Click the “Fork” button at the top-right of a repository page to create your own copy of the repository.

Clone Your Fork

Clone your forked repository to your local machine:

git clone [email protected]:zeroth-robotics/<your username>/<repository name>.git
cd zeroth-robotics

Create a New Branch

Create a branch for your changes:

git checkout -b my-feature

Make Your Changes

Add your changes and test them locally.

Commit Your Changes

Commit your work with a clear message:

git add .
git commit -m "Add a clear description of your changes"

Push to Your Fork

Push your changes to your forked repository:

git push origin my-feature

Submit a Pull Request

Go to the original repository and click “New Pull Request.” Follow the prompts to open a pull request. Please include a thorough description of your changes.

Code Style Guidelines

To ensure consistency, please follow these guidelines:

  • Write clear, concise commit messages.
  • Adhere to the coding standards of the project.
  • Test your changes thoroughly before submitting.

Joining the Community

Connect with us and other contributors on our Discord for questions, discussions, and real-time collaboration.

Reporting Issues

To report a bug or suggest a new feature, please use the Issues tab for the corresponding repository on Github. Include as much detail as possible, such as steps to reproduce, screenshots, or error logs.

Thank You!

Your contributions help make Zeroth Robotics a success. Whether it’s fixing a typo or implementing a major feature, we thank you for your contribution to open source robotics.

Happy coding!

EdgeVLAHUMANOID OLYMPICS