Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 1.34 KB

File metadata and controls

40 lines (25 loc) · 1.34 KB

Contributing to elab

Thanks for your interest in contributing! This is primarily a personal lab notebook, but corrections, improvements, and additional findings are welcome.


What's Welcome

  • Bug fixes — wrong pin numbers, incorrect register addresses, broken code
  • Corrections — if something is factually wrong, please open an issue
  • Additions — if you've done the same experiment and found something different or interesting
  • Improvements — better ways to do something already documented

What's Not the Goal

  • Rewriting lab notes to be more "tutorial-like" — the rough edges are intentional
  • Adding new unrelated projects — this repo follows a specific set of hardware

How to Contribute

  1. Open an issue first for anything non-trivial so we can discuss it
  2. Fork the repo and create a branch: fix/hb0100-spi-pinout or add/hb0100-gyro-analysis
  3. Keep changes focused and small
  4. Submit a PR with a clear description of what you changed and why

Code Style

  • Arduino sketches should compile cleanly with zero warnings where possible
  • Comments should explain why, not what
  • If you add a function, add a brief comment describing its purpose

License

By contributing, you agree that your contributions will be licensed under the same Apache 2.0 license that covers this project.