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] Design doc for CodeFlare SDK #703

Merged

Conversation

varshaprasad96
Copy link
Contributor

This PR adds design documentation for CodeFlare SDK to the repository for reference in future.

Issue link

What changes have been made

Verification steps

Checks

  • I've made sure the tests are passing.
  • Testing Strategy
    • Unit tests
    • Manual tests
    • Testing is not required for this change

@openshift-ci openshift-ci bot requested review from dimakis and Fiona-Waters October 8, 2024 18:38
Copy link

codecov bot commented Oct 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.11%. Comparing base (2e28f8a) to head (f2602fd).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #703   +/-   ##
=======================================
  Coverage   94.11%   94.11%           
=======================================
  Files          36       36           
  Lines        2412     2412           
=======================================
  Hits         2270     2270           
  Misses        142      142           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@dimakis dimakis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work Varsha. I've a couple of comments

docs/designs/CodeFlare-SDK-design-doc.md Outdated Show resolved Hide resolved
docs/designs/CodeFlare-SDK-design-doc.md Outdated Show resolved Hide resolved
docs/designs/CodeFlare-SDK-design-doc.md Outdated Show resolved Hide resolved
docs/designs/CodeFlare-SDK-design-doc.md Outdated Show resolved Hide resolved
docs/designs/CodeFlare-SDK-design-doc.md Outdated Show resolved Hide resolved
docs/designs/CodeFlare-SDK-design-doc.md Outdated Show resolved Hide resolved
docs/designs/CodeFlare-SDK-design-doc.md Outdated Show resolved Hide resolved
docs/designs/CodeFlare-SDK-design-doc.md Outdated Show resolved Hide resolved
docs/designs/CodeFlare-SDK-design-doc.md Show resolved Hide resolved
docs/designs/CodeFlare-SDK-design-doc.md Outdated Show resolved Hide resolved
docs/designs/CodeFlare-SDK-design-doc.md Outdated Show resolved Hide resolved
@varshaprasad96 varshaprasad96 force-pushed the add/sdk-desing-doc branch 4 times, most recently from c72f652 to 648b374 Compare October 14, 2024 22:32
Copy link
Contributor

@franciscojavierarceo franciscojavierarceo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some small nits but otherwise this lgtm!

@Bobbins228
Copy link
Contributor

Just need to resolve conflict and it lgtm

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 17, 2024
@openshift-ci openshift-ci bot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Oct 17, 2024
This PR adds design documentation for CodeFlare SDK to the repository for
reference in future.
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Oct 18, 2024
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 18, 2024
@varshaprasad96
Copy link
Contributor Author

@Bobbins228 could you approve the PR if everything looks good? Thanks! :)

Copy link
Contributor

@Bobbins228 Bobbins228 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work Varsha, Bualadh bos(Irish for applause)!
/lgtm /approve

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Oct 21, 2024
Copy link
Contributor

openshift-ci bot commented Oct 21, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Bobbins228, franciscojavierarceo

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [Bobbins228,franciscojavierarceo]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@Bobbins228 Bobbins228 enabled auto-merge October 22, 2024 08:33
@Bobbins228 Bobbins228 added this pull request to the merge queue Oct 22, 2024
Merged via the queue into project-codeflare:main with commit aee7c20 Oct 22, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants