2.0 KiB
Contributing to Meshtastic Firmware
We're excited that you're interested in contributing to the Meshtastic firmware! This document provides a high-level overview of how you can get involved.
Important First Steps
Before you begin, please:
-
Read our documentation: Our official documentation is a crucial resource. It contains essential information about the project, including setup guides, feature explanations, and contribution guidelines.
-
Check out the firmware build guide: For specific instructions on setting up your development environment and building the firmware, refer to our Firmware Build Guide.
-
Read our Code of Conduct
-
Join our Discord community to connect with other contributors and get help
Getting Help and Discussing Ideas
We encourage open communication and discussion before diving into code changes:
-
Use GitHub Discussions: For new ideas, questions, or to discuss potential changes, start a conversation in our GitHub Discussions first. This helps us collaborate and avoid duplicate work.
-
Join our Discord: For real-time chat and quick questions, join our Discord server. It's a great place to get help and connect with the community.
-
Reporting Issues: If you've identified a bug, please use our bug report template when creating a new issue in the issue tracker. Ensure you've searched existing issues to avoid duplicates.
Making Contributions
- Fork the repository
- Create a new branch for your feature or bug fix
- Make your changes
- Test your changes thoroughly
- Create a pull request with a clear description of your changes
Coding Standards
[Placeholder for coding standards]
Thank you for contributing to Meshtastic!