Skip to content

Commit 819bc88

Browse files
Merge pull request #8 from ni-kismet/users/cwaterma/snyk-contributing
.snyk file and Snyk README guidance
2 parents b848ec0 + 2480605 commit 819bc88

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

.snyk

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
2+
exclude: {}
3+
version: v1.25.1
4+
ignore: {}
5+
patch: {}

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1072,6 +1072,16 @@ $ mongod --sslMode allowSSL --sslPEMKeyFile /path/to/mongodb.pem
10721072
- For `--sslMode` you can use one of `allowSSL` or `preferSSL`
10731073
- You can enable any other options you want when starting `mongod`
10741074

1075+
## Security scanning with Snyk
1076+
1077+
This repository uses [Snyk](https://snyk.io/) for security scanning to identify and fix vulnerabilities in code before they reach production. Snyk provides Static Application Security Testing (SAST) that scans your code for security issues as you develop.
1078+
1079+
- **IDE integration**: Install the Snyk extension for [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=snyk-security.snyk-vulnerability-scanner) or [Visual Studio](https://marketplace.visualstudio.com/items?itemName=snyk-security.snyk-vulnerability-scanner-vs-2022) to get real-time security feedback while writing code. To suggest the Snyk extension to contributors, add `.vscode/extensions.json` or `.vsconfig` files to your project root. The VSCode Snyk extension has a richer feature set and is the preferred IDE for working with Snyk.
1080+
- **Pull request scanning**: Snyk automatically scans PRs and posts comments for high/critical vulnerabilities.
1081+
- **Post-merge monitoring**: Automated bugs are created for unresolved issues after code is merged.
1082+
1083+
For detailed guidance on working with Snyk, including how to address security issues and create ignore records, see the [Snyk reference](https://dev.azure.com/ni/DevCentral/_wiki/wikis/Stratus/146862/Snyk-reference).
1084+
10751085
## Special Thanks
10761086

10771087
Special thanks to [JetBrains](https://www.jetbrains.com/?from=elixir-mongodb-driver) for providing a free JetBrains Open Source license for their complete toolbox.

0 commit comments

Comments
 (0)