docs.waku.org/docs/contribute.md

37 lines
2.3 KiB
Markdown
Raw Normal View History

2023-05-22 12:35:34 +00:00
---
title: Contribute to Waku
---
2023-05-29 13:56:25 +00: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 12:35:34 +00:00
2023-06-19 17:07:45 +00:00
- [Running a node](/guides/nodes-and-sdks#run-a-waku-node) within your application.
2023-05-29 13:56:25 +00:00
- [Reporting bugs](#report-a-bug) and [suggesting missing features](#suggest-a-feature) to the development team.
- Completing [Waku Bounties](#complete-waku-bounties) and participating in our [Bug Bounty Programme](#submit-security-bug-reports).
2023-06-02 17:25:07 +00:00
- Inspiring other developers to explore and use Waku for [various use cases](/overview/use-cases).
2023-05-22 12:35:34 +00:00
2023-06-08 12:28:25 +00:00
Begin your journey by visiting the [Nodes and SDKs](/guides/nodes-and-sdks) guide and start building on Waku today!
2023-05-22 12:35:34 +00: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 13:56:25 +00:00
## Suggest a Feature
2023-05-22 12:35:34 +00: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 prioritise accordingly.
2023-05-22 12:35:34 +00:00
2023-05-23 11:50:55 +00:00
## Make Pull Requests
2023-05-22 12:35:34 +00:00
2023-05-29 13:56:25 +00: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 12:35:34 +00:00
2023-06-20 11:41:55 +00:00
## Complete Waku Bounties
To promote community contributions, we encourage members to complete bounties that benefit Waku and earn rewards while positively impacting the network. Join the bounty programme at: <https://github.com/waku-org/bounties>.
2023-06-20 11:41:55 +00:00
2023-06-02 22:45:28 +00:00
## Submit Security Bug Reports
To improve Waku's security, we invite researchers to collaborate in identifying and resolving potential vulnerabilities and earn rewards for their efforts. To participate, please review our bug bounty programme's details and submit your reports at: <https://hackenproof.com/status-dot-im/waku>.
2023-06-02 22:45:28 +00:00
2023-05-22 12:35:34 +00:00
## Contribute to Waku Research
Waku Research is an innovative R&D project dedicated to developing modular peer-to-peer protocols for communication that prioritise privacy, security, and censorship resistance. Explore Waku's ongoing challenges and experimental code at <https://github.com/waku-org/research>.