Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (65 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

86 lines (65 loc) · 2.85 KB
Raw

Contributing to Cheapbox

Thank you for your interest in contributing to Cheapbox. This document outlines how to participate effectively.

Ways to Contribute

Hardware

  • PCB variations for other RP2040 boards (XIAO RP2040, Feather RP2040, RP2040-Zero, etc.)
  • Improved enclosure designs (better ergonomics, printability, mounting)
  • Alternative component footprints or BOM optimizations
  • Schematics and PCB files in KiCad, Eagle, or other formats

Firmware & Software

  • GP2040-CE configuration profiles for specific games or platforms
  • Custom firmware builds or patches
  • Web configurator improvements or translations

Documentation

  • Build guides with photos or video links
  • Assembly instructions for specific variations
  • Troubleshooting guides
  • Translations of this README and docs

Community

  • Answer questions in issues/discussions
  • Share your build photos and modifications
  • Report bugs or suggest improvements

Getting Started

  1. Fork the repository
  2. Create a branch for your change: 
    git checkout -b feature/your-change-name
  3. Make your changes following the guidelines below
  4. Test your changes if applicable (build the hardware, flash firmware, verify)
  5. Submit a pull request with a clear description

Guidelines

Hardware Changes

  • Include schematic and PCB files in source format (KiCad preferred)
  • Document BOM changes with part numbers and supplier links
  • Provide renderings or photos of the assembled board
  • Note any firmware configuration changes required
  • Test with GP2040-CE before submitting

Enclosure Changes

  • Provide STEP/STL files and source files (Fusion 360, FreeCAD, OpenSCAD, etc.)
  • Include print settings (layer height, infill, supports, orientation)
  • Document any hardware changes needed (different bolts, board mounting)
  • Photos of printed and assembled parts strongly encouraged

Documentation

  • Use clear, concise language
  • Include images with descriptive alt text
  • Link to external resources (datasheets, tutorials) when helpful
  • Keep formatting consistent with existing docs

Code/Firmware

  • Follow GP2040-CE coding standards if modifying firmware
  • Test on actual hardware when possible
  • Document configuration changes needed

Pull Request Process

  1. Ensure your PR addresses a single logical change
  2. Update documentation if your change affects user-facing behavior
  3. The maintainers will review and may request changes
  4. Once approved, your PR will be merged

Code of Conduct

Be respectful, constructive, and inclusive. Harassment, discrimination, or hostile behavior will not be tolerated.

Questions?

Open an issue for:

  • Design discussions before starting work
  • Clarification on contribution guidelines
  • Help with tooling or file formats

By contributing, you agree that your contributions will be licensed under the MIT License (same as the project).