-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ADRs: 007-011 - Adding Impact Sections #1456
ADRs: 007-011 - Adding Impact Sections #1456
Conversation
- added Impact section - updated content and formatting
- updated for clarity and formatting - filled Impact section
- filled Impact section - updated formatting
- filled in Impact section - updated formatting
- filled in Impact section for 011 - updated formatting
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨Explore these optional code suggestions:
|
- **Vulnerability Scanning:** With the ability to integrate with tools like [Anchore/Grype](https://github.com/anchore/grype#recommended), one can easily add vulnerability scanning to the process. | ||
|
||
|
||
- **Format Conversion:** supports integration with Anchore/Syft for SBOM format conversion, providing flexibility to meet different ecosystem requirements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nitpick, but 'supports' is lowercase when the other points are capitalized.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Help me with this @pluckyswan - Some of the bullets read like a sentence if you remove the colon (like the one you've pointed out here. Should I just add a period so it looks more like a sentence or rephrase ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think rephrasing might help it come across more as a sentence
@@ -1,9 +1,12 @@ | |||
# 11. OWASP ZAP Dynamic Application Security Testing | |||
# 11. OWASP ZAP Dynamic Application Security Testing (DAST) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the criteria for what's abbreviated here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@pluckyswan - I didn't touch too much of the top sections unless they just didn't explain enough. As long as the acronym was expanded on somewhere at the top of the doc, I left it alone. Also, In this case OWASP and ZAP are expanded under the decision section. Open to suggested changes though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was just curious since the IaC terraform ADR had both, but if it's expanded somewhere in the file it's probably good :)
- applying changes suggested in the PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I approve, but there is an extraneous quote.
remove quote Co-authored-by: halprin <halprin@users.noreply.github.com>
Quality Gate passedIssues Measures |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good stuff
Impact section completion for ADRs 007-011
This PR covers filling in the impact sections for ADRs 007-011 so that it is understood why the decision was made at the time and what the concerns were.
Issue #1247
Checklist