Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (29 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.65 KB

Contributing to Project Aura

First off, thank you for considering contributing to Project Aura! It's people like you that make the open-source community such an amazing place to learn, inspire, and create.

Legal: The Contributor License Agreement (CLA)

Project Aura uses a Dual Licensing model (GPLv3 for open source, Commercial for proprietary use). To maintain this model, I require all contributors to agree to a Contributor License Agreement (CLA).

By submitting a pull request, you automatically agree to the terms in CLA.md.

This agreement gives 21CNCStudio the right to use your contribution in both the open-source and commercial versions of the firmware, while you retain copyright ownership of your code.

Found a Bug?

If you find a bug in the source code or a mistake in the documentation, please submit an issue.

Before you submit:

  1. Search existing issues to avoid duplicates.
  2. Check GitHub Discussions for Q&A.

Contributing Code

I love pull requests! Here's a quick guide:

  1. Fork the repository and create your branch from main.
  2. Code:
    • Keep changes focused and well-scoped.
    • Follow the existing code style.
    • Add SPDX headers to new files (copy from existing files).
  3. Test: Run tests (scripts/run_tests.ps1) or verify on hardware.
  4. Pull Request:
    • Open a PR against the main branch.
    • Describe your changes clearly.

Questions?

For general questions, hardware help, or showing off your build, please join the GitHub Discussions.

Thanks!