-
Notifications
You must be signed in to change notification settings - Fork 272
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
Add a design doc template #3556
Add a design doc template #3556
Conversation
Signed-off-by: Stephen Crawford <steecraw@amazon.com>
Codecov Report
@@ Coverage Diff @@
## main #3556 +/- ##
============================================
- Coverage 65.04% 65.00% -0.04%
+ Complexity 3650 3646 -4
============================================
Files 283 283
Lines 20619 20619
Branches 3392 3392
============================================
- Hits 13411 13403 -8
- Misses 5528 5536 +8
Partials 1680 1680 |
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.
Thanks for spending the time to write this up, what do you think about quickly translating an existing feature into this template so we can see how it looks in practice?
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.
Thank you @scrawfor99 for adding this. One suggestion I'd make is to have a check-list of items necessary for documenting design. Maybe we can update the pull-request template to have one more section for design documentation? Thoughts?
Signed-off-by: Stephen Crawford <steecraw@amazon.com>
Signed-off-by: Stephen Crawford <steecraw@amazon.com>
Description
This change introduces a new markdown file for people looking to make major changes to the Security plugin.
It covers basic information about what a design doc should use and a tool for knowing what info is required.
Check List
New functionality includes testingBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.