Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (24 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

32 lines (24 loc) · 1.45 KB

CONTRIBUTING TO ML01 PROJECT

Thank you for considering contributing.
It is through community involvement that projects like this evolve and improve.

License Agreement

By contributing to this repository, you agree that:

  • Your code contributions (Python, HTML) will be licensed under the MIT License.
  • Your documentation contributions will be licensed under CC BY-NC-SA 4.0.

How Can I Contribute?

Reporting Bugs

  • Check the Issues tab to see if the bug has already been reported.
  • If not, open a new issue. Include your firmware version, a clear description of the bug, and steps to reproduce it.

Suggesting Enhancements

  • We welcome new LED animation modes or web interface improvements.
  • Open an issue first to discuss the idea before starting the development.

Pull Requests (Code)

  1. Fork the repository.
  2. Create a branch for your feature (git checkout -b feature/amazing-new-mode).
  3. Ensure your code follows MicroPython best practices (efficiency and low memory usage).
  4. Commit your changes with clear messages.
  5. Open a Pull Request targeting the main branch.

💬 Questions?

If you have questions about the assembly or configuration, please refer to the Assembly & Settings files first.
For other inquiries, feel free to open a "Question" issue.

Thank you for being part of the ML01 project journey!