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

Breakdown flowchart models into separate files #2144

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

SajidAlamQB
Copy link
Contributor

@SajidAlamQB SajidAlamQB commented Oct 17, 2024

Description

Related to: #1909

Development notes

Added the following:

QA notes

Checklist

  • Read the contributing guidelines
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added new entries to the RELEASE.md file
  • Added tests to cover my changes

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
return info.data["id"]


class RegisteredPipeline(NamedEntity):
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @SajidAlamQB , most of the splitting looks good. Some suggestions -

On first look, entities file is not obvious on what it contains but the class names make sense here. I would have the below structure -

  • flowchart
    • nodes
    • node_metadata
    • edge
    • pipelines
    • tag
    • model_utils
  • NamedEntity can be in entity or model_utils
  • RegisteredPipeline can be in pipelines and Tag in its own tag file.
  • Model file names are singular if we are not having multiple classes (nodes and pipelines can be plural as they have collection of classes)

Thank you

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
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.

3 participants