Update README.md
Costa Tsaousis committed
Jul 17, 2023 at 14:30 UTC
561a79542e427ee7ab686bcf12db1972f6f5281b
1 file changed
+21
-5
README.md
+21
-5
@@ -275,7 +275,7 @@ Netdata's documentation is available at [**Netdata Learn**](https://learn.netdat
275
This site also hosts a number of [guides](https://learn.netdata.cloud/guides) to help newer users better understand how
276
to collect metrics, troubleshoot via charts, export to external databases, and more.
277
278
-## Community
278
+## :tada: Community
279
280
Netdata is an inclusive open-source project and community. Please read our [Code of Conduct](https://github.com/netdata/.github/blob/main/CODE_OF_CONDUCT.md).
281
@@ -293,14 +293,30 @@ You can also find Netdata on:
293
- [Repology](https://repology.org/metapackage/netdata/versions)
294
- [Facebook](https://www.facebook.com/linuxnetdata/)
295
296
-## Contribute
296
+## :pray: Contribute
297
298
-Contributions are essential to the success of open-source projects. While we continue to invest in and improve Netdata, we need your help!
298
+Contributions are essential to the success of open-source projects. In other words, we need you help to keep Netdata great!
299
300
+What is a contribution? All the following are highly valuable to Netdata:
301
+
302
+1. **Let us know of the best-practices you believe should be standardized**<br/>
303
+ Netdata should out-of-the-box detect as many infrastructure issues as possible. By sharing your knowledge and experiences, you help us build a monitoring solution that has baked into it all the best-practices about infrastructure monitoring.
304
+
305
+2. **Let us know if Netdata is not perfect for your use case**<br/>
306
+ We aim to support as many use cases, operating systems and integrations, as possible. We rely on you to bring to our attention that Netdata is sub-optimal for a certain use-case. Open a github issue, or start a github discussion about it, to discuss what you need and what you believe Netdata should be doing for your use case. Keep in mind though that we cant' promise we will implement it. We prioritize development on use-cases that are common to our community, are in the same direction we want Netdata to evolve and are aligned with our roadmap.
307
+
308
+3. **Support other community members**<br/>
309
+ Join our community on Github, Discord and Reddit and help them out. Generally, Netdata is relatively easy to setup and configure, but still people may need a little push in the right direction to use it effectively. Supporting other members is a great contribution by itself!
310
+
311
+4. **Add or improve integrations you need**<br/>
312
+ Integrations are generally easier and simpler to develop. If you want to contribute code to Netdata, we suggest to start with integrations you need and Netdata may not currently support.
313
+
314
+General information about contributions:
315
+
316
+- Check our [Security Policy](https://github.com/netdata/netdata/security/policy).
317
+- Found a bug? Open a [GitHub issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml&title=%5BBug%5D%3A+).
318
- Read our [Contributing Guide](https://github.com/netdata/.github/blob/main/CONTRIBUTING.md), which contains all the information you need to contribute to Netdata, such as improving our documentation, engaging in the community, and developing new features. We've made it as frictionless as possible, but if you need help, just ping us on our community forums!
319
- We have a whole category dedicated to contributing and extending Netdata on our [community forums](https://community.netdata.cloud/c/agent-development/9)
302
-- Found a bug? Open a [GitHub issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml&title=%5BBug%5D%3A+).
303
-- View our [Security Policy](https://github.com/netdata/netdata/security/policy).
320
321
Package maintainers should read the guide on [building Netdata from source](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/source.md) for
322
instructions on building each Netdata component from the source and preparing a package.