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

Breaking changes: Refactoring of new architecture #56

Merged
merged 20 commits into from
Dec 11, 2023

Conversation

Wh1isper
Copy link
Collaborator

@Wh1isper Wh1isper commented Dec 8, 2023

Description

I will be designing the overall project architecture for the betterment of the project.

Until this PR is merged, all design and related documentation changes will be placed in here: https://synthetic-data-generator.readthedocs.io/en/breaking-refactoring/index.html

Motivation and Context

Motivation: https://synthetic-data-generator.readthedocs.io/en/breaking-refactoring/design/motivation.html

Architecture: https://synthetic-data-generator.readthedocs.io/en/breaking-refactoring/design/architecture.html

How has this been tested?

Types of changes

  • Maintenance (no change in code, maintain the project's CI, docs, etc.)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@Wh1isper Wh1isper added documentation Improvements or additions to documentation enhancement New feature or request SDG Future labels Dec 8, 2023
@Wh1isper Wh1isper added this to the 0.1.0 milestone Dec 8, 2023
@Wh1isper Wh1isper self-assigned this Dec 8, 2023
Copy link
Contributor

sweep-ai bot commented Dec 8, 2023

Apply Sweep Rules to your PR?

  • Apply: All new business logic should have corresponding unit tests.
  • Apply: Refactor large functions to be more modular.
  • Apply: Add docstrings to all functions and file headers.

@Wh1isper
Copy link
Collaborator Author

Wh1isper commented Dec 8, 2023

I'll ping reviewers when it's ready.

Feel free to comment anytime, thanks!

@Wh1isper Wh1isper marked this pull request as ready for review December 11, 2023 10:03
@Wh1isper
Copy link
Collaborator Author

Wh1isper commented Dec 11, 2023

@MooooCat

This PR is long enough with the following modifications:

I'd like to request to merge this PR first for others who can benefit from the framework.

BTW, I prefer squash and merge for a clean commit tree

Copy link
Contributor

@MooooCat MooooCat left a comment

Choose a reason for hiding this comment

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

Glad to see more further results achieved under the new architecture.

@MooooCat MooooCat merged commit 814f0f3 into main Dec 11, 2023
9 checks passed
@Wh1isper Wh1isper deleted the breaking-refactoring branch December 11, 2023 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request SDG Future
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants