meshtastic/docs/about/contributing.mdx

144 lines
8.7 KiB
Plaintext
Raw Permalink Normal View History

2021-04-11 18:29:30 -07:00
---
title: Contributing to Meshtastic
2022-11-02 11:46:54 -07:00
sidebar_label: Contributing
slug: /contributing
2022-11-03 17:10:08 -07:00
sidebar_position: 3
description: "Get involved with Meshtastic's open-source project. Contribute to device firmware, web apps, or mobile and desktop apps. Your expertise can help enhance this volunteer-driven communication platform."
2021-04-11 18:29:30 -07:00
---
2024-02-10 09:37:01 -08:00
import Link from "@docusaurus/Link"
2024-04-03 14:44:34 -07:00
import ThemedImage from '@theme/ThemedImage';
import useBaseUrl from '@docusaurus/useBaseUrl';
## Volunteer Based Development
2023-06-24 21:50:02 -07:00
Meshtastic is a team of volunteers, and as such there are always plenty of ways to help. This project gets great contributions from people in their off hours. Those contributors work on the features they are interested in. It is a very open and welcoming developer community, and we are always looking for help to improve Meshtastic.
2021-11-05 19:20:16 -07:00
- If you're a developer, there's plenty stuff to do. Dig in!
- If you're interacting with Meshtastic radios, we could use help with testing, documenting, and providing feedback.
- If you're into Web Development, check out the different web repos.
- If you're into Kotlin and Android, check out the link to the repo below.
- If you're into Python, check out the link to the repo below
2023-06-24 21:50:02 -07:00
- If you're into SwiftUI, check out the link to the repo below
- If you're into Ham Radio and LoRa, then this is a great project for you!
- ... basically... we would love to have your help and feedback
2021-11-05 19:20:16 -07:00
2022-04-08 08:03:47 -07:00
There are several developers, testers, and active users on [Discord](https://discord.gg/ktMAKGBnBs).
2021-12-26 12:06:27 -08:00
### Meshtastic Ecosystem
2021-12-26 12:06:27 -08:00
The Meshtastic ecosystem leverages a variety of technologies and repositories to provide a robust decentralized communication platform. This ecosystem is continuously evolving, thanks to the collaborative effort of developers, contributors, and the community, aiming to enhance and expand Meshtastic's capabilities for decentralized off-grid communication.
Key components include:
- **Protocol Buffers**: The backbone of communication and interactions, with changes and definitions managed in the [Meshtastic Protobuf Definitions repository](https://github.com/meshtastic/protobufs). For detailed information, see the [Protobuf API Reference](https://buf.build/meshtastic/protobufs/).
- **Device Firmware**: Development for ESP32, nRF52, and RP2040 based devices occurs in the [firmware repository](https://github.com/meshtastic/firmware), focusing on C and C++ code for hardware interaction and communication.
- **Firmware Modules**: Extend the core functionalities of devices and mesh networks, implemented mainly within the firmware repository. Modules are essential for adding new features and integrating devices within the ecosystem.
- **CLI Apps (Device Interface)**: The [Meshtastic Python CLI](https://github.com/meshtastic/Meshtastic-python) enables interaction with device settings and functionalities, serving both as a utility and a library for application development.
- **Web and JavaScript Apps**: Development for the hosted web server on ESP32 devices is done in [Meshtastic Web](https://github.com/meshtastic/web), with a JavaScript library for device interfaces available in [Meshtastic JS](https://github.com/meshtastic/meshtastic.js).
- **Mobile and Desktop Apps**: Android, iOS, iPadOS, and macOS applications provide user interfaces for interacting with Meshtastic devices. Development for Android is detailed in the [Meshtastic-Android repository](https://github.com/meshtastic/Meshtastic-Android), while Apple platforms are supported by the [Meshtastic-Apple repository](https://github.com/meshtastic/Meshtastic-Apple).
2024-02-12 10:54:46 -08:00
- **Documentation**: The source for the Meshtastic website and documentation resides in the [meshtastic/meshtastic repository](https://github.com/meshtastic/meshtastic). For guidelines on maintaining documentation, visit the [Maintaining Documentation](/docs/development/docs) page.
2021-11-05 19:20:16 -07:00
2024-02-12 11:18:55 -08:00
This ecosystem is continuously evolving, thanks to the collaborative effort of developers, contributors and the community, aiming to enhance and expand Meshtastic's capabilities for decentralized off-grid communication.
2021-12-26 12:06:27 -08:00
## Supporting and Contributing to Meshtastic
The Meshtastic project benefits greatly from the contributions of our volunteers and the financial support from our community. As the project has evolved, the expansion of features and services has led to increased financial needs, including hardware for development, GitHub fees, hosting for public MQTT services, among others. This growth into a robust platform for decentralized off-grid mesh networking solutions showcases the dedication of our developers and the generosity of our financial supporters.
2021-11-05 19:20:16 -07:00
### How You Can Support Meshtastic Financially
2021-11-05 19:20:16 -07:00
If direct development contribution is not feasible for you, financial support is another invaluable way to help Meshtastic grow and thrive. We offer two primary options for monetary donations:
<div className="indexCtasBody">
<div className="split-container">
<div className="split-item">
<a
className="button button--outline button--lg cta--button"
href="https://opencollective.com/meshtastic"
target="_blank"
rel="noopener noreferrer"
>
Support on Open Collective
</a>
</div>
2021-12-26 12:06:27 -08:00
<div className="split-item">
<a
className="button button--outline button--lg cta--button"
href="https://github.com/sponsors/meshtastic"
target="_blank"
rel="noopener noreferrer"
>
Sponsor on GitHub
</a>
</div>
</div>
</div>
2021-11-05 19:20:16 -07:00
2024-09-09 12:25:18 -07:00
### Sponsors
2024-09-09 13:01:47 -07:00
We're deeply thankful for the backing from our sponsors, listed below, which has been instrumental in our project's sustainability and growth. Their support enables us to continue serving and expanding our community.
2021-12-26 12:06:27 -08:00
<div className="flex flex-wrap items-start">
<div className="w-full sm:w-3/12 p-3">
<ThemedImage
2024-04-03 15:30:34 -07:00
alt="Open Collective"
className="max-h-8"
sources={{
2024-09-08 11:05:19 -07:00
light: useBaseUrl("/img/contributing/Open_Collective_logo_2021.svg"),
dark: useBaseUrl("/img/contributing/Open_Collective_logo_2021.svg"),
}}
2024-04-03 15:30:34 -07:00
/>
</div>
<div className="w-full sm:w-9/12 p-3">
2024-04-03 14:44:34 -07:00
Our collaboration with Open Collective and Open Source Collective offers a robust fiscal management framework and banking solutions, supporting our project alongside over three thousand other open source initiatives. Open Collective's transparent framework lets everyone see our finances, including income, expenditures, and contributions on [Meshtastic's Open Collective page](https://opencollective.com/meshtastic). This transparency and support affirm that we're in excellent company.
2024-04-03 15:30:34 -07:00
</div>
2024-04-03 14:44:34 -07:00
</div>
<div className="flex flex-wrap items-start">
<div className="w-full sm:w-3/12 p-3">
2024-04-03 15:30:34 -07:00
<ThemedImage
alt="This project is supported by DigitalOcean"
className="max-h-8"
2024-04-03 15:30:34 -07:00
sources={{
light: useBaseUrl('https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/PoweredByDO/DO_Powered_by_Badge_blue.svg'),
dark: useBaseUrl('https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/PoweredByDO/DO_Powered_by_Badge_blue.svg'),
}}
/>
</div>
<div className="w-full sm:w-9/12 p-3">
2024-04-03 14:44:34 -07:00
Champions of open source, DigitalOcean supports Meshtastic through credits, which significantly aid our development, infrastructure, and testing efforts. This contribution is part of their commitment to fostering innovation and collaboration within the open source ecosystem.
2024-04-03 15:30:34 -07:00
</div>
2024-04-03 14:44:34 -07:00
</div>
<div className="flex flex-wrap items-start">
<div className="w-full sm:w-3/12 p-3">
2024-04-03 15:30:34 -07:00
<ThemedImage
alt="Vercel"
className="max-h-8"
2024-04-03 15:30:34 -07:00
sources={{
2024-09-08 11:05:19 -07:00
light: useBaseUrl('/img/contributing/vercel-logotype-dark.svg'),
dark: useBaseUrl('/img/contributing/vercel-logotype-light.svg'),
2024-04-03 15:30:34 -07:00
}}
/>
</div>
<div className="w-full sm:w-9/12 p-3">
2024-04-03 14:44:34 -07:00
By covering our hosting costs, Vercel directly contributes to Meshtastic's growth, enhancing our web scalability and presence. Their sponsorship is crucial for our continued development and focus on creating a robust platform for decentralized communication.
2024-04-03 15:30:34 -07:00
</div>
2024-04-03 14:44:34 -07:00
</div>
2024-09-08 11:05:19 -07:00
<div className="flex flex-wrap items-start">
<div className="w-full sm:w-3/12 p-3">
<ThemedImage
alt="Datadog"
className="max-h-8"
sources={{
light: useBaseUrl("/img/contributing/dd_logo_h_rgb.svg"),
dark: useBaseUrl("/img/contributing/dd_logo_h_white.svg"),
}}
/>
</div>
<div className="w-full sm:w-9/12 p-3">
Datadog is an observability and security platform for cloud applications, providing infrastructure monitoring, application performance monitoring, and log management. They sponsor us by granting free infrastructure monitoring and logging, aiding our development and operational efforts.
</div>
</div>