docs.waku.org/docs/contribute.md

31 lines
1.9 KiB
Markdown
Raw Normal View History

2023-05-22 13:35:34 +01:00
---
title: Contribute to Waku
---
2023-05-29 14:56:25 +01:00
Get involved in Waku's open-source initiatives to improve the protocols, SDKs, developer tools and examples, and documentation. You can contribute by:
2023-05-22 13:35:34 +01:00
2023-06-09 20:32:04 +01:00
- [Operating a node](/guides/nodes-and-sdks#run-a-waku-node) within your application.
2023-05-29 14:56:25 +01:00
- [Reporting bugs](#report-a-bug) and [suggesting missing features](#suggest-a-feature) to the development team.
2023-06-02 18:25:07 +01:00
- Inspiring other developers to explore and use Waku for [various use cases](/overview/use-cases).
2023-05-22 13:35:34 +01:00
2023-06-08 13:28:25 +01:00
Begin your journey by visiting the [Nodes and SDKs](/guides/nodes-and-sdks) guide and start building on Waku today!
2023-05-22 13:35:34 +01:00
## Report a Bug
To report a bug, create an issue in the appropriate [GitHub repository](https://github.com/waku-org). Ensure no issue exists about the bug and include detailed steps to reproduce the bug.
2023-05-29 14:56:25 +01:00
## Suggest a Feature
2023-05-22 13:35:34 +01:00
2023-05-29 14:56:25 +01:00
To suggest a new feature, create an issue in the appropriate [GitHub repository](https://github.com/waku-org). Ensure no issue exists about the feature and specify the use cases the feature can enable, allowing us to investigate and prioritize accordingly.
2023-05-22 13:35:34 +01:00
2023-05-23 12:50:55 +01:00
## Make Pull Requests
2023-05-22 13:35:34 +01:00
2023-05-29 14:56:25 +01:00
Community pull requests (PRs) are highly encouraged, but we recommend [suggesting a feature](#suggest-a-feature) first to gauge interest and gather feedback before proceeding with a PR.
2023-05-22 13:35:34 +01:00
2023-06-02 23:45:28 +01:00
## Submit Security Bug Reports
2023-06-05 09:09:50 +01:00
To improve Waku's security, we invite researchers to collaborate in identifying and resolving potential vulnerabilities. To participate, please review our bug bounty program's details and submit your reports at: <https://hackenproof.com/status-dot-im/waku>.
2023-06-02 23:45:28 +01:00
2023-05-22 13:35:34 +01:00
## Contribute to Waku Research
2023-05-29 17:44:53 +01:00
Waku Research is an innovative R&D project dedicated to developing modular peer-to-peer protocols for communication that prioritize privacy, security, and censorship resistance. Explore Waku's ongoing challenges and experimental code at <https://github.com/waku-org/research>.