Commit 46ec5ac
doc: add info on project's usage of coverity
Document project's used of coverity and how
collaborators can get access.
Signed-off-by: Michael Dawson <mdawson@devrus.com>
PR-URL: #40506
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>1 parent d81b65c commit 46ec5ac
3 files changed
Lines changed: 22 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -12,3 +12,6 @@ emeritus or leaves the project. | |||
| 12 | 12 | a team listing. For example, if someone is removed from @nodejs/build, | |
| 13 | 13 | they should also be removed from the Build WG README.md file in the | |
| 14 | 14 | <https://github.com/nodejs/build> repository. | |
| 15 | + * Open an issue in the [build](https://github.com/nodejs/build) repository | ||
| 16 | + titled `Remove Collaborator from Coverity` asking that the collaborator | ||
| 17 | + be removed from the Node.js coverity project if they had access. | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,16 @@ | |||
| 1 | + # Static Analysis | ||
| 2 | + | ||
| 3 | + The project uses Coverity to scan Node.js source code and to report potential | ||
| 4 | + issues in the C/C++ code base. | ||
| 5 | + | ||
| 6 | + Those who have been added to the Node.js coverity project can receive emails | ||
| 7 | + when there are new issues reported as well as view all current issues | ||
| 8 | + through [https://scan9.coverity.com/reports.htm](https://scan9.coverity.com/reports.htm). | ||
| 9 | + | ||
| 10 | + Any collaborator can ask to be added to the Node.js coverity project | ||
| 11 | + by opening an issue in the [build](https://github.com/nodejs/build) repository | ||
| 12 | + titled `Please add me to coverity`. A member of the build WG with admin | ||
| 13 | + access will verify that the requestor is an existing collaborator as listed in | ||
| 14 | + the [colloborators section](https://github.com/nodejs/node#collaborators) | ||
| 15 | + on the nodejs/node project repo. Once validated the requestor will added | ||
| 16 | + to to the coverity project. | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -249,6 +249,8 @@ needs to be pointed out separately during the onboarding. | |||
| 249 | 249 | project. The Foundation has travel funds to cover participants' expenses | |
| 250 | 250 | including accommodations, transportation, visa fees, etc. if needed. Check out | |
| 251 | 251 | the [summit](https://github.com/nodejs/summit) repository for details. | |
| 252 | + * If you are interested in helping to fix coverity reports consider requesting | ||
| 253 | + access to the projects coverity project as outlined in [static-analysis][]. | ||
| 252 | 254 | ||
| 253 | 255 | [Code of Conduct]: https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md | |
| 254 | 256 | [Labels]: doc/guides/collaborator-guide.md#labels | |
@@ -259,6 +261,7 @@ needs to be pointed out separately during the onboarding. | |||
| 259 | 261 | [`git-node`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md | |
| 260 | 262 | [`node-core-utils`]: https://github.com/nodejs/node-core-utils | |
| 261 | 263 | [set up the credentials]: https://github.com/nodejs/node-core-utils#setting-up-github-credentials | |
| 264 | + [static-analysis]: doc/guides/static-analysis.md | ||
| 262 | 265 | [two-factor authentication]: https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/ | |
| 263 | 266 | [using a TOTP mobile app]: https://help.github.com/articles/configuring-two-factor-authentication-via-a-totp-mobile-app/ | |
| 264 | 267 | [who-to-cc]: doc/guides/collaborator-guide.md#who-to-cc-in-the-issue-tracker | |
0 commit comments