@cryptotaxi247 / netdata-1 / commits / 8b7440943

Contributing revamp, take 2 (#10956)

* revamp fix, mqtt, makefil * Update README.md Co-authored-by: Joel Hans <joel.g.hans@gmail.com> * Update README.md Co-authored-by: Joel Hans <joel.g.hans@gmail.com> * Update README.md Co-authored-by: Joel Hans <joel.g.hans@gmail.com> * Update README.md Co-authored-by: Joel Hans <joel.g.hans@gmail.com> * remove #menu link from menu Co-authored-by: Joel Hans <joel.g.hans@gmail.com>

Odysseas Lamtzidis committed Apr 15, 2021 at 19:27 UTC 8b744094388019122513eb83c6aaa21f335bfa2c

6 files changed +14 -518

CODE_OF_CONDUCT.md deleted

-80

@@ -1,80 +0,0 @@

1 -<!--

2 -title: "Netdata Community Code of Conduct"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/CODE_OF_CONDUCT.md

4 --->

5 -

6 -# Netdata Community Code of Conduct

7 -

8 -## Our Pledge

9 -

10 -In the interest of fostering an open and welcoming environment, we as

11 -contributors, maintainers and community members pledge to making participation in our project and

12 -our community a harassment-free experience for everyone, regardless of age, body

13 -size, disability, ethnicity, sex characteristics, gender identity and expression,

14 -level of experience, education, socio-economic status, nationality, personal

15 -appearance, race, religion, or sexual identity and orientation.

16 -

17 -## Our Standards

18 -

19 -Examples of behavior that contributes to creating a positive environment

20 -include:

21 -

22 -- Using welcoming and inclusive language

23 -- Being respectful of differing viewpoints and experiences

24 -- Gracefully accepting constructive criticism

25 -- Focusing on what is best for the community

26 -- Showing empathy towards other community members

27 -

28 -Examples of unacceptable behavior by participants include:

29 -

30 -- The use of sexualized language or imagery and unwelcome sexual attention or

31 - advances

32 -- Trolling, insulting/derogatory comments, and personal or political attacks

33 -- Public or private harassment

34 -- Publishing others' private information, such as a physical or electronic

35 - address, without explicit permission

36 -- Other conduct which could reasonably be considered inappropriate in a

37 - professional setting

38 -

39 -## Our Responsibilities

40 -

41 -Project maintainers are responsible for clarifying the standards of acceptable

42 -behavior and are expected to take appropriate and fair corrective action in

43 -response to any instances of unacceptable behavior.

44 -

45 -Project maintainers have the right and responsibility to remove, edit, or

46 -reject comments, commits, code, documentation edits, issues, community posts, and other contributions

47 -that are not aligned to this Code of Conduct, or to ban temporarily or

48 -permanently any contributor for other behaviors that they deem inappropriate,

49 -threatening, offensive, or harmful.

50 -

51 -## Scope

52 -

53 -This Code of Conduct applies both within project spaces and in public spaces

54 -when an individual is representing the project or its community. Examples of

55 -representing a project or community include using an official project e-mail

56 -address, posting via an official social media account, or acting as an appointed

57 -representative at an online or offline event. Representation of a project may be

58 -further defined and clarified by project maintainers.

59 -

60 -## Enforcement

61 -

62 -Instances of abusive, harassing, or otherwise unacceptable behavior may be

63 -reported by contacting Netdata at info@netdata.cloud. All

64 -complaints will be reviewed and investigated and will result in a response that

65 -is deemed necessary and appropriate to the circumstances. The project team is

66 -obligated to maintain confidentiality with regard to the reporter of an incident.

67 -Further details of specific enforcement policies may be posted separately.

68 -

69 -Project maintainers who do not follow or enforce the Code of Conduct in good

70 -faith may face temporary or permanent repercussions as determined by other

71 -members of the project's leadership.

72 -

73 -## Attribution

74 -

75 -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,

76 -available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>

77 -

78 -[homepage]: https://www.contributor-covenant.org

79 -

80 -[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2FCODE_OF_CONDUCT&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

CONTRIBUTING.md deleted

-241

@@ -1,241 +0,0 @@

1 -<!--

2 -title: "Contributing"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/CONTRIBUTING.md

4 -sidebar_label: "Contributing handbook"

5 --->

6 -

7 -# Contributing

8 -

9 -Thank you for considering contributing to Netdata.

10 -

11 -We love to receive contributions. Maintaining a platform for monitoring everything imaginable requires a broad understanding of a plethora of technologies, systems and applications. We rely on community contributions and user feedback to continue providing the best monitoring solution out there.

12 -

13 -There are many ways to contribute, with varying requirements of skills, explained in detail in the following sections.

14 -Specific GitHub issues we need help with can be seen [here](https://github.com/netdata/netdata/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22). Some of them are also labeled as "good first issue".

15 -

16 -## All Netdata Users

17 -

18 -### Give Netdata a GitHub star

19 -

20 -This is the minimum open-source users should contribute back to the projects they use. Github stars help the project gain visibility, stand out. So, if you use Netdata, consider pressing that button. **It really matters**.

21 -

22 -### Join the Netdata Community

23 -

24 -We have launched a [discussion board](https://community.netdata.cloud) where you can find many of us.

25 -

26 -### Spread the word

27 -

28 -Community growth allows the project to attract new talent willing to contribute. This talent is then developing new features and improves the project. These new features and improvements attract more users and so on. It is a loop. So, post about Netdata, present it to local meetups you attend, let your online social network or twitter, facebook, reddit, etc. know you are using it. **The more people involved, the faster the project evolves**.

29 -

30 -### Provide feedback

31 -

32 -Is there anything that bothers you about Netdata? Did you experience an issue while installing it or using it? Would you like to see it evolve to match your requirements? Let us know by making a post at [at Netdata Community](https://community.netdata.cloud/category/4/feedback) to discuss it or [open a GitHub issue](https://github.com/netdata/netdata/issues). Feedback is very important for open-source projects. We can't commit we will do everything, but your feedback influences [our roadmap](https://community.netdata.cloud/category/1/announcements-and-roadmap) significantly. **We rely on your feedback to make Netdata better**.

33 -

34 -### Translate some documentation

35 -

36 -The [Netdata localization project](https://github.com/netdata/localization) contains instructions on how to provide translations for parts of our documentation. Translating the entire documentation is a daunting task, but you can contribute as much as you like, even a single file. The Chinese translation effort has already begun and we are looking forward to more contributions.

37 -

38 -### Sponsor a part of Netdata

39 -

40 -Netdata is a complex system, with many integrations for the various collectors, backends and notification endpoints. As a result, we rely on help from "sponsors", a concept similar to "power users" or "product owners". To become a sponsor, just let us know in any Github issue and we will record your GitHub username in a "CONTRIBUTORS.md" in the appropriate directory.

41 -

42 -#### Sponsor a collector

43 -

44 -Netdata is all about simplicity and meaningful presentation. A "sponsor" for a collector does the following:

45 -

46 -- Assists the devs with feedback on the charts.

47 -- Specifies the alarms that would make sense for each metric.

48 -- When the implementation passes QA, tests the implementation in production.

49 -- Uses the charts and alarms in his/her day to day work and provides additional feedback.

50 -- Requests additional improvements as things change (e.g. new versions of an API are available).

51 -

52 -#### Sponsor an exporting connector

53 -

54 -We already support various [exporting connectors](/exporting/README.md), and we intend to support more. A "sponsor" for a connector:

55 -

56 -- Suggests ways in which the information in Netdata could best be exposed to the particular endpoint, to facilitate meaningful presentation.

57 -- When the implementation passes QA, tests the implementation in production.

58 -- Uses the backend in his/her day to day work and provides additional feedback, after the backend is delivered.

59 -- Requests additional improvements as things change (e.g. new versions of the backend API are available).

60 -

61 -#### Sponsor a notification method

62 -

63 -Netdata delivers alarms via various [notification methods](health/notifications). A "sponsor" for a notification method:

64 -

65 -- Points the devs to the documentation for the API and identifies any unusual features of interest (e.g. the ability in Slack to send a notification either to a channel or to a user).

66 -- Uses the notification method in production and provides feedback.

67 -- Requests additional improvements as things change (e.g. new versions of the API are available).

68 -

69 -## Experienced Users

70 -

71 -### Help other users

72 -

73 -As the project grows, an increasing share of our time is spent on supporting this community of users in terms of answering questions, of helping users understand how Netdata works and find their way with it. Helping other users is crucial. It allows the developers and maintainers of the project to focus on improving it.

74 -

75 -### Improve documentation

76 -

77 -Our documentation is in need of constant improvement and expansion. As Netdata's features grow, we need to clearly explain how each feature works and document all the possible configurations. And as Netdata's community grows, we need to improve existing documentation to make it more accessible to people of all skill levels.

78 -

79 -We also need to produce beginner-level tutorials on using Netdata to monitor common applications, web servers, and more.

80 -

81 -Start with the [guide for contributing to documentation](/docs/contributing/contributing-documentation.md), and then review the [documentation style guide](/docs/contributing/style-guide.md) for specifics on how we write our documentation.

82 -

83 -Don't be afraid to submit a pull request with your corrections or additions! We need a lot of help and are willing to guide new contributors through the process.

84 -

85 -## Developers

86 -

87 -We expect most contributions to be for new data collection plugins. You can read about how external plugins work [here](collectors/plugins.d/). Additional instructions are available for [Node.js plugins](collectors/node.d.plugin) and [Python plugins](collectors/python.d.plugin).

88 -

89 -Of course we appreciate contributions for any other part of the Netdata agent, including the [daemon](daemon), [backends for long term archiving](backends/), innovative ways of using the [REST API](web/api) to create cool [Custom Dashboards](web/gui/custom/) or to include Netdata charts in other applications, similarly to what can be done with [Confluence](web/gui/confluence/).

90 -

91 -If you are working on the C source code please be aware that we have a standard build configuration that we use. This

92 -is meant to keep the source tree clean and free of warnings. When you are preparing to work on the code:

93 -```

94 -CFLAGS="-O1 -ggdb -Wall -Wextra -Wformat-signedness -fstack-protector-all -DNETDATA_INTERNAL_CHECKS=1 -D_FORTIFY_SOURCE=2 -DNETDATA_VERIFY_LOCKS=1" ./netdata-installer.sh --disable-lto --dont-wait

95 -```

96 -

97 -Typically we will enable LTO during production builds. The reasons for configuring it this way are:

98 -

99 -| CFLAG / argument | Reasoning |

100 -| ---------------- | --------- |

101 -| `-O1` | This makes the debugger easier to use as it disables optimisations that break the relationship between the source and the state of the debugger |

102 -| `-ggdb` | Enable debugging symbols in gdb format (this also works with clang / llbdb) |

103 -| `-Wall -Wextra -Wformat-signedness` | Really, definitely, absolutely all the warnings |

104 -| `-DNETDATA_INTERNAL_CHECKS=1` | This enables the debug.log and turns on the macro that outputs to it |

105 -| `-D_FORTIFY_SOURCE=2` | Enable buffer-overflow checks on string-processing functions |

106 -| `-DNETDATA_VERIFY_LOCKS=1` | Enable extra checks and debug |

107 -| `--disable-lto ` | We enable LTO for production builds, but disable it during development are it can hide errors about missing symbols that have been pruned. |

108 -

109 -Before submitting a PR we run through this checklist:

110 -

111 -* Compilation warnings

112 -* valgrind

113 -* ./netdata-installer.sh

114 -* make dist

115 -* `packaging/makeself/build-x86_64-static.sh`

116 -* `clang-format -style=file`

117 -

118 -Please be aware that the linting pass at the end is currently messy as we are transitioning between code styles

119 -across most of our code-base, but we prefer new contributions that match the linting style.

120 -

121 -### Contributions Ground Rules

122 -

123 -#### Code of Conduct and CLA

124 -

125 -We expect all contributors to abide by the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). For a pull request to be accepted, you will also need to accept the [Netdata contributors license agreement](CONTRIBUTORS.md), as part of the PR process.

126 -

127 -#### Performance and efficiency

128 -

129 -Everything on Netdata is about efficiency. We need Netdata to always be the most lightweight monitoring solution available. We will reject to merge PRs that are not optimal in resource utilization and efficiency.

130 -

131 -Of course there are cases that such technical excellence is either not reasonable or not feasible. In these cases, we may require the feature or code submitted to be by disabled by default.

132 -

133 -#### Meaningful metrics

134 -

135 -Unlike other monitoring solutions, Netdata requires all metrics collected to have some structure attached to them. So, Netdata metrics have a name, units, belong to a chart that has a title, a family, a context, belong to an application, etc.

136 -

137 -This structure is what makes Netdata different. Most other monitoring solution collect bulk metrics in terms of name-value pairs and then expect their users to give meaning to these metrics during visualization. This does not work. It is neither practical nor reasonable to give to someone 2000 metrics and let him/her visualize them in a meaningful way.

138 -

139 -So, Netdata requires all metrics to have a meaning at the time they are collected. We will reject to merge PRs that loosely collect just a "bunch of metrics", but we are very keen to help you fix this.

140 -

141 -#### Automated Testing

142 -

143 -Netdata is a very large application to have automated testing end-to-end. But automated testing is required for crucial functions of it.

144 -

145 -Generally, all pull requests should be coupled with automated testing scenarios. However since we do not currently have a framework in place for testing everything little bit of it, we currently require automated tests for parts of Netdata that seem too risky to be changed without automated testing.

146 -

147 -Of course, manual testing is always required.

148 -

149 -#### Netdata is a distributed application

150 -

151 -Netdata is a distributed monitoring application. A few basic features can become quite complicated for such applications. We may reject features that alter or influence the nature of Netdata, though we usually discuss the requirements with contributors and help them adapt their code to be better suited for Netdata.

152 -

153 -#### Operating systems supported

154 -

155 -Netdata should be running everywhere, on every production system out there.

156 -

157 -Although we focus on **supported operating systems**, we still want Netdata to run even on non-supported systems. This, of course, may require some more manual work from the users (to prepare their environment, or enable certain flags, etc).

158 -

159 -If your contributions limit the number of operating systems supported we will request from you to improve it.

160 -

161 -#### Documentation

162 -

163 -Your contributions should be bundled with related documentation to help users understand how to use the features you introduce.

164 -

165 -#### Maintenance

166 -

167 -When you contribute code to Netdata, you are automatically accepting that you will be responsible for maintaining that code in the future. So, if users need help, or report bugs, we will invite you to the related github issues to help them or fix the issues or bugs of your contributions.

168 -

169 -#### Code Style

170 -

171 -The single most important rule when writing code is this: *check the surrounding code and try to imitate it*. [Reference](https://developer.gnome.org/programming-guidelines/stable/c-coding-style.html.en)

172 -

173 -We use several different languages and have had contributions from several people with different styles. When in doubt, you can check similar existing code.

174 -

175 -For C contributions in particular, we try to respect the [Linux kernel style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html), with the following exceptions:

176 -

177 -- Use 4 space indentation instead of 8

178 -- We occasionally have multiple statements on a single line (e.g. `if (a) b;`)

179 -- Allow max line length of 120 chars

180 -- Allow opening brace at the end of a function declaration: `function() {`.

181 -- Allow trailing comments

182 -

183 -### Your first pull request

184 -

185 -There are several guides for pull requests, such as the following:

186 -

187 -- <https://thenewstack.io/getting-legit-with-git-and-github-your-first-pull-request/>

188 -- <https://github.com/firstcontributions/first-contributions#first-contributions>

189 -

190 -However, it's not always that simple. Our [PR approval process](#pr-approval-process) and the several merges we do every day may cause your fork to get behind the Netdata master. If you worked on something that has changed in the meantime, you will be required to do a git rebase, to bring your fork to the correct state. A very easy to follow guide on how to do it without learning all the intricacies of GitHub can be found [here](https://medium.com/@ruthmpardee/git-fork-workflow-using-rebase-587a144be470)

191 -

192 -One thing you will need to do only for your first pull request in Netdata is to accept the CLA. Until you do, the automated check for the CLA acceptance will be showing as failed.

193 -

194 -#### PR Guidelines

195 -

196 -PR Titles:

197 -

198 -- Must follow the [Imperative Mood](https://en.wikipedia.org/wiki/Imperative_mood)

199 -- Must be no more than ~50 characters (_longer description in the PR_)

200 -

201 -PR Descriptions:

202 -

203 -- Must clearly contain sufficient information regarding the content of the PR, including area/component, test plan, etc.

204 -- Must reference an existing issue.

205 -

206 -Some PR title examples:

207 -

208 -- Fix bug in Netdata installer for FreeBSD 11.2

209 -- Update docs for other installation methods

210 -- Add new collector for Prometheus endpoints

211 -- Add 4.19 Kernel variant for eBPF

212 -- Fix typo in README

213 -- Refactor code for better maintainability

214 -- etc

215 -

216 -The key idea here is to start with a "verb" of what you are doing in the PR.

217 -

218 -For good examples have a look at other projects like:

219 -

220 -- https://github.com/facebook/react/commits/master

221 -- https://github.com/tensorflow/tensorflow/commits/master

222 -- https://github.com/vuejs/vue/commits/dev

223 -- https://github.com/microsoft/vscode/commits/master

224 -- Also see the Linux Kernel and Git projects as well as good examples.

225 -

226 -#### Commit messages when PRs are merged

227 -

228 -When a PR gets squashed and merged into master, the title of the commit message (first line) must be the PR title

229 -followed by the PR number.

230 -

231 -The body of the commit message should be a short description of the work, preferably taken from the connected issue.

232 -

233 -### PR approval process

234 -

235 -Each PR automatically [requires a review](https://help.github.com/articles/about-required-reviews-for-pull-requests/) from the code owners specified in `.github/CODEOWNERS`. Depending on the files contained in your PR, several people may be needed to approve it.

236 -

237 -We also have a series of automated checks running, such as linters to check code quality and QA tests. If you get an error or warning in any of those checks, you will need to click on the link included in the check to identify the root cause, so you can fix it.

238 -

239 -If you wish to open a PR but are not quite ready for the code to be reviewed, you can open it as a Draft PR (click the dropdown on the **Create PR** button and select **Draft PR**). This will prevent reviewers from being notified initially so that you can keep working on the PR. Once you're ready, you can click the **Ready for Review** button near the bottom of the PR to mark it ready and notify the relevant reviewers.

240 -

241 -[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2FCONTRIBUTING&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

CONTRIBUTORS.md deleted

-136

@@ -1,136 +0,0 @@

1 -<!--

2 -SPDX-License-Identifier: GPL-3.0-or-later

3 --->

4 -

5 -# Netdata contributors license agreement

6 -

7 -**Thank you for contributing to Netdata!**

8 -

9 -This agreement is part of the legal framework of the open-source ecosystem

10 -that adds some red tape, but protects both the contributor and the project.

11 -

12 -To understand why this is needed, please read [a well-written chapter from

13 -Karl Fogel’s Producing Open Source Software on CLAs](https://producingoss.com/en/contributor-agreements.html).

14 -

15 -By signing this agreement, you do not change your rights to use your own

16 -contributions for any other purpose.

17 -

18 -## copyright license

19 -

20 -The Contributor (_you_) grants Netdata Inc. a perpetual, worldwide, non-exclusive,

21 -no-charge, royalty-free, irrevocable copyright license to reproduce,

22 -prepare derivative works of, publicly display, publicly perform, sublicense,

23 -and distribute his contributions and such derivative works.

24 -

25 -## copyright transfer

26 -

27 -The Contributor (_you_) hereby assigns Netdata Inc. copyright in his

28 -contributions, to be licensed under the same terms as the rest of the code.

29 -

30 -> _Note: this means we may re-license Netdata (your contributions included)

31 -> any way we see fit, without asking your permission.

32 -> We intend to keep the Netdata agent forever FOSS.

33 -> But open-source licenses have significant differences and in our attempt to

34 -> help Netdata grow we may have to distribute it under a different license.

35 -> For example, CNCF, the Cloud Native Computing Foundation, requires Netdata

36 -> to be licensed under Apache-2.0 for it to be accepted as a member of the

37 -> Foundation. We want to be free to do it._

38 -

39 -## original work

40 -

41 -The Contributor (_you_) represent that each of his contributions is his

42 -original creation and that he is legally entitled to grant the above license.

43 -

44 -> _Note: if you are committing third party code, please make sure the third party

45 -> license or any other restrictions are also included with your commits.

46 -> Netdata includes many third party libraries and tools and this is not a

47 -> problem, provided that the license of the third party code is compatible with

48 -> the one we use for Netdata._

49 -

50 -## signature

51 -

52 -Since Sep 17th 2018, we use <https://cla-assistant.io/netdata/netdata> for signing the CLA, on all pull requests.

53 -Old contributors can sign the CLA at any time using this link.

54 -

55 -## HISTORICAL SIGNATURES

56 -

57 -(they have been imported to <https://cla-assistant.io/netdata/netdata> already)

58 -

59 -The Contributor (_you_) signs this agreement by adding his personal data in

60 -this document and committing it to the project repo

61 -(the same way contributions are submitted to the project).

62 -

63 -By signing once, all contributions (past and future) of The Contributor (_you_),

64 -are subject to this agreement.

65 -

66 -> _Note: so you have to:_

67 ->

68 -> 1. add your github username and name in this file

69 -> 2. commit it to the repo with a PR, using the same github username, or include this change in your first PR.

70 -

71 -# Netdata contributors

72 -

73 -This is the list of contributors that have signed this agreement:

74 -

75 -|username|name|email (optional)|

76 -|:------:|:--:|:---------------|

77 -|@lets00|Luís Eduardo|leduardo@lsd.ufcg.edu.br|

78 -|@ktsaou|Costa Tsaousis|costa@tsaousis.gr|

79 -|@tycho|Steven Noonan|steven@uplinklabs.net|

80 -|@philwhineray|Phil Whineray||

81 -|@paulfantom|Paweł Krupa|pawel@krupa.net.pl|

82 -|@Ferroin|Austin S. Hemmelgarn|ahferroin7@gmail.com|

83 -|@glensc|Elan Ruusamäe||

84 -|@l2isbad|Ilya Mashchenko|ilyamaschenko@gmail.com|

85 -|@rlefevre|Rémi Lefèvre||

86 -|@vlvkobal|Vladimir Kobal|vlad@prokk.net|

87 -|@simonnagl|Simon Nagl||

88 -|@manosf|Emmanouil Fokas|manosf@protonmail.com|

89 -|@user501254|Ashesh Singh|user501254@gmail.com|

90 -|@t-h-e|Stefan Forstenlechner||

91 -|@facetoe|Facetoe||

92 -|@ntlug|Christopher Cox|ccox@endlessnow.com|

93 -|@alonbl|Alon Bar-Lev|alon.barlev@gmail.com|

94 -|@Wing924|Wei He|weihe924stephen@gmail.com|

95 -|@NeonSludge|Kirill Buev|kirill.buev@gmx.com|

96 -|@kmlucy|Kyle Lucy|kmlucy@gmail.com|

97 -|@RicardoSette|Ricardo Sette|ricardosette@freebsdbrasil.com.br|

98 -|@383c57|Shinichi Tagashira||

99 -|@davidak|David Kleuker|netdata-contributors+vyff@davidak.de|

100 -|@ccremer|Christian Cremer||

101 -|@jimcooley|Jim Cooley|jim.cooley@healthvana.com|

102 -|@Chocobo1|Mike Tzou||

103 -|@vinyasmusic|Vinyas Malagaudanavar|vinyasmusic@gmail.com|

104 -|@cosmix|Dimosthenis Kaponis||

105 -|@shadycuz|Levi Blaney|shadycuz+spam@gmail.com|

106 -|@Flums|Philip Gabrielsen|philip@digno.no|

107 -|@domschl|Dominik Schlösser|dominik.schloesser@gmail.com|

108 -|@tioumen|Guillaume Hospital||

109 -|@arch273|Jacob Ayres||

110 -|@x4FF3|David Fuellgraf||

111 -|@jasonwbarnett|Jason Barnett||

112 -|@ecowed|Ed Wade||

113 -|@wungad|Rob Man||

114 -|@rda0|Sven Mäder|maeder@phys.ethz.ch|

115 -|@alibo|Ali Borhani|aliborhani1@gmail.com|

116 -|@Nani-o|Sofiane Medjkoune|sofiane@medjkoune.fr|

117 -|@n0guest|Evgeniy K.|ask@osshelp.ru|

118 -|@amichelic|Adalbert Michelic||

119 -|@abalabahaha|abalabahaha|hi@abal.moe|

120 -|@illes|Illes S.||

121 -|@plasticrake|Patrick Seal||

122 -|@jonfairbanks|Jon Fairbanks||

123 -|@pjz|Paul Jimenez|pj@place.org|

124 -|@jgrossiord|Julien Grossiord|julien@grossiord.net|

125 -|@pohzipohzi|Poh Zi How||

126 -|@vladmovchan|Vladyslav Movchan|vladislav.movchan@gmail.com|

127 -|@gmosx|George Moschovitis||

128 -|@adherzog|Adam Herzog|adam@adamherzog.com|

129 -|@skrzyp1|Jerzy S.||

130 -|@akwan|Alan Kwan||

131 -|@underhood|Timotej Šiškovič||

132 -|@stevenh|Steven Hartland|steven.hartland@multiplay.co.uk|

133 -|@dpsy4|Dave Sitek||

134 -|@devinrsmith|Devin Smith||

135 -

136 -[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2FCONTRIBUTORS&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

Makefile.am

-3

@@ -37,11 +37,8 @@ EXTRA_DIST = \

37 build/m4/tcmalloc.m4 \

38 build/m4/ax_c__generic.m4 \

39 README.md \

40 - CONTRIBUTORS.md \

41 - CODE_OF_CONDUCT.md \

40 LICENSE \

41 REDISTRIBUTED.md \

44 - CONTRIBUTING.md \

42 $(NULL)

44 SUBDIRS = \

README.md

+14 -7

@@ -44,7 +44,11 @@ Netdata](https://user-images.githubusercontent.com/1153921/96495792-2e881380-11f

45 - [Features](#features)

46 - [Get Netdata](#get-netdata)

47 + - [Docker](#docker)

48 + - [Other operating systems](#other-operating-systems)

49 + - [Post-installation](#post-installation)

50 - [How it works](#how-it-works)

51 +- [Infographic](#infographic)

52 - [Documentation](#documentation)

53 - [Community](#community)

54 - [Contribute](#contribute)

@@ -190,11 +194,14 @@ to collect metrics, troubleshoot via charts, export to external databases, and m

194

195 ## Community

196

193 -You can find most of the Netdata team in our [community forum](https://community.netdata.cloud). It's the best place to

194 -ask questions, find resources, and get to know the Netdata team.

197 +Netdata is an inclusive open-source project and community. Please read our [Code of Conduct](https://learn.netdata.cloud/contribute/code-of-conduct).

198 +

199 +Find most of the Netdata team in our [community forums](https://community.netdata.cloud). It's the best place to

200 +ask questions, find resources, and engage with passionate professionals.

201

202 You can also find Netdata on:

203

204 +- [Reddit](https://www.reddit.com/r/netdata/)

205 - [Facebook](https://www.facebook.com/linuxnetdata/)

206 - [Twitter](https://twitter.com/linuxnetdata)

207 - [StackShare](https://stackshare.io/netdata)

@@ -203,10 +210,12 @@ You can also find Netdata on:

210

211 ## Contribute

212

206 -We welcome [contributions](/CONTRIBUTING.md) to our code and to our

207 -[documentation](/docs/contributing/contributing-documentation.md). Feel free to join the team!

213 +Contributions are the lifeblood of open-source projects. While we continue to invest in and improve Netdata, we need help to democratize monitoring!

214

209 -To report bugs or get help, use [GitHub's issues](https://github.com/netdata/netdata/issues).

215 +- Read our [Contributing Guide](https://learn.netdata.cloud/contribute/handbook), 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!

216 +- We have a whole category dedicated to contributing and extending Netdata on our [community forums](https://community.netdata.cloud/c/agent-development/9)

217 +- Found a bug? Open a [GitHub issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2C+needs+triage&template=bug_report.md).

218 +- View our [Security Policy](https://github.com/netdata/netdata/security/policy).

219

220 Package maintainers should read the guide on [building Netdata from source](/packaging/installer/methods/source.md) for

221 instructions on building each Netdata component from source and preparing a package.

@@ -225,5 +234,3 @@ _When people first hear about a new product, they frequently ask if it is any go

234

235 > Note to self: Starting immediately, all raganwald projects will have a “Is it any good?” section in the readme, and

236 > the answer shall be “yes.".

228 -

229 -So, we follow the tradition...

SECURITY.md deleted

-51

@@ -1,51 +0,0 @@

1 -<!--

2 -title: "Security Policy"

3 -description: "The Netdata team maintains and adheres to a formal process any time a member of the community reports a security vulnerability."

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/SECURITY.md

5 --->

6 -

7 -# Security Policy

8 -

9 -## Supported Versions

10 -

11 -| Version | Supported |

12 -|------- | --------- |

13 -| Latest | Yes |

14 -

15 -## Reporting a Vulnerability

16 -

17 -We're extremely grateful for security researchers and users that report vulnerabilities to Netdata Open Source Community. All reports are thoroughly investigated by a set of community volunteers.

18 -

19 -To make a report, please send an email to **security@netdata.cloud** with

20 -the vulnerability details and the details expected for [all Netdata bug

21 -reports](https://github.com/netdata/netdata/blob/c1f4c6cf503995cd4d896c5821b00d55afcbde87/.github/ISSUE_TEMPLATE/bug_report.md).

22 -

23 -### When Should I Report a Vulnerability?

24 -

25 -- You think you discovered a potential security vulnerability in Netdata

26 -- You are unsure how a vulnerability affects Netdata

27 -- You think you discovered a vulnerability in another project that Netdata depends on (e.g. python, node, etc)

28 -

29 -### When Should I NOT Report a Vulnerability?

30 -

31 -- You need help tuning Netdata for security

32 -- You need help applying security related updates

33 -- Your issue is not security related

34 -

35 -### Security Vulnerability Response

36 -

37 -Each report is acknowledged and analyzed by Netdata Team members within 3 working days. This will set off a Security Release Process.

38 -

39 -Any vulnerability information shared with the Netdata Team stays within the Netdata project and will not be disseminated to other projects unless it is necessary to get the issue fixed.

40 -

41 -As the security issue moves from triage, to identified fix, to release planning we will keep the reporter updated.

42 -

43 -### Public Disclosure Timing

44 -

45 -A public disclosure date is negotiated by the Netdata team and the bug submitter. We prefer to fully disclose the bug as soon as possible once a user mitigation is available. It is reasonable to delay disclosure when the bug or the fix is not yet fully understood, the solution is not well-tested, or for vendor coordination. The timeframe for disclosure is from immediate (especially if it's already publicly known) to a few weeks. As a basic default, we expect report date to disclosure date to be on the order of 7 days. The Netdata team holds the final say when setting a disclosure date.

46 -

47 -### Security Announcements

48 -

49 -Every time a security issue is fixed in Netdata, we immediately release a new version of it. So, to get notified of all security incidents, please subscribe to our releases on github.

50 -

51 -[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2FSECURITY&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)