Skip to content
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

Merged
merged 6 commits into from
Oct 25, 2023

Conversation

stephen-crawford
Copy link
Collaborator

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 testing
  • New functionality has been documented
  • Commits are signed per the DCO using --signoff

By 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.

Signed-off-by: Stephen Crawford <steecraw@amazon.com>
@codecov
Copy link

codecov bot commented Oct 17, 2023

Codecov Report

Merging #3556 (dccc810) into main (ccc3e34) will decrease coverage by 0.04%.
The diff coverage is n/a.

Impacted file tree graph

@@             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              

see 3 files with indirect coverage changes

Copy link
Member

@peternied peternied left a 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?

DESIGN_DOCUMENT_TEMPLATE.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
DESIGN_DOCUMENT_TEMPLATE.md Outdated Show resolved Hide resolved
DESIGN_DOCUMENT_TEMPLATE.md Outdated Show resolved Hide resolved
DESIGN_DOCUMENT_TEMPLATE.md Outdated Show resolved Hide resolved
DESIGN_DOCUMENT_TEMPLATE.md Outdated Show resolved Hide resolved
DESIGN_DOCUMENT_TEMPLATE.md Outdated Show resolved Hide resolved
DESIGN_DOCUMENT_TEMPLATE.md Outdated Show resolved Hide resolved
DESIGN_DOCUMENT_TEMPLATE.md Outdated Show resolved Hide resolved
DESIGN_DOCUMENT_TEMPLATE.md Outdated Show resolved Hide resolved
Copy link
Member

@DarshitChanpura DarshitChanpura left a 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?

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Stephen Crawford <steecraw@amazon.com>
stephen-crawford and others added 3 commits October 24, 2023 12:44
Signed-off-by: Stephen Crawford <steecraw@amazon.com>
Signed-off-by: Stephen Crawford <steecraw@amazon.com>
@peternied peternied merged commit 60c9a86 into opensearch-project:main Oct 25, 2023
59 checks passed
@peternied peternied deleted the design_doc branch October 25, 2023 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants