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 how to start contributing with confidence and get your work reviewed and merged.

​
Before you start

Set yourself up for success by preparing the basics before making changes.
  • A GitHub account and a local Git setup
  • Familiarity with pull requests (PRs) and branching workflows
  • The tools required for your contribution area:
    • Software: a C/C++ toolchain and your preferred IDE/editor
    • Hardware: your preferred CAD/PCB tools and access to a printer/fab as needed
    • Documentation: a Markdown/MDX-capable editor
Familiarize yourself with the repository 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.

​
Types of contributions

  • Bug fixes and performance improvements
  • New features and hardware iterations
  • Documentation updates and examples
  • Issue triage, testing, and review feedback
Small, incremental changes are easier to review and merge than large, multi-purpose PRs.

​
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.
You’ve picked an issue or created one to discuss your idea before building a solution.
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
Your local repository is set up and you can run basic build or validation steps relevant to your contribution area.
3

Create a branch for your changes

Use a descriptive branch name that reflects your work:
git checkout -b fix/motor-calibration-bug
Use short, consistent prefixes like fix/, feat/, or docs/ to make your intent clear.
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.
Keep changes focused on a single goal. If you discover unrelated issues, open separate PRs.
5

Test and verify locally

  • Software: build and bench-test; add or update unit tests if available
  • Hardware: validate dimensions, tolerances, and fit; include images or test prints where possible
  • Documentation: build or preview the docs locally and fix broken links
Your change works as intended and does not break existing functionality.
6

Commit your changes

Write clear, conventional commit messages so reviewers understand your intent:
git add .
git commit -m "fix: correct motor calibration routine to prevent stall at startup"
Group related changes into logical commits. Avoid mixing refactors and feature changes in one commit.
7

Push your branch and open a pull request

Push your branch and open a pull request on GitHub. Include:
  • A clear description of what you changed and why
  • References to any related issues (for example, “Fixes #123”)
  • Screenshots, test results, or photos of hardware prints if applicable
Your PR description helps reviewers reproduce your results and understand your approach.
8

Collaborate during review and iterate

Maintainers may request changes—this is a normal part of keeping quality high. Address feedback with follow-up commits on the same branch.
All review comments are resolved, CI (if applicable) is passing, and your PR is ready to merge.

​
Getting help

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

​
Troubleshooting

  • Ensure your branch is up to date with main:
git fetch origin
git checkout main
git pull --ff-only
git checkout your-branch
git rebase main
  • Resolve conflicts locally, run your tests, and force-push the updated branch.
  • Read the failure logs to identify the exact step that failed
  • Verify formatting/linting requirements and re-run tests locally
  • Ask for guidance in the PR if the failure isn’t clear
  • Re-check critical dimensions and tolerances
  • Share photos and notes in your PR so others can reproduce and advise
Only contribute content you have the rights to share. Do not include sensitive information, private data, or keys in commits, code, or screenshots.
By following this guide, you’ll be able to propose changes, collaborate with maintainers, and get your contributions merged with confidence.