Skip to main content
OSSM is built by a global community of makers, engineers, and enthusiasts. Whether you’re fixing a typo or designing new features, every contribution matters. This guide walks you through the process of becoming a contributor.

​
Before you start

Familiarize yourself with the project structure:
  • Software — Firmware and control code in the /Software directory
  • Hardware — CAD files, PCB designs, and printed parts in their respective directories
  • Documentation — Guides and references in the /Documentation directory

Forking the Repository

Learn how to create your own copy of the OSSM repository to work on.

​
Contribution workflow

1

Find something to work on

Browse open issues to find something that interests you. Issues labeled good first issue are ideal starting points for new contributors.
If you have an idea that isn’t already an issue, open one first to discuss it with maintainers before investing significant time.
2

Fork and clone the repository

Create your own fork on GitHub, then clone it locally:
git clone https://github.com/YOUR-USERNAME/OSSM-hardware.git
cd OSSM-hardware
3

Create a branch for your changes

Use a descriptive branch name that reflects your work:
git checkout -b fix/motor-calibration-bug
4

Make your changes

Follow the contribution guidelines for your area of work:

Hardware Contribution Guide

Standards for CAD models, printed parts, and mechanical design.

Software Contribution Guide

Coding standards, testing requirements, and firmware guidelines.
5

Submit a pull request

Push your branch and open a pull request on GitHub. Include:
  • A clear description of what you changed and why
  • Reference to any related issues (e.g., “Fixes #123”)
  • Screenshots or test results if applicable
Maintainers will review your pull request and may request changes. This is a normal part of the process—it helps maintain code quality.

​
Getting help

If you get stuck or have questions:
  • Ask in the pull request — Maintainers and other contributors can help
  • Join the community Discord — Connect with other makers for real-time help
  • Check existing documentation — Many common questions are already answered
We appreciate contributors of all skill levels. Don’t hesitate to ask questions—the community is here to help you succeed.