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

Update readme #245

Merged
merged 5 commits into from
May 16, 2024
Merged

Update readme #245

merged 5 commits into from
May 16, 2024

Conversation

chowbao
Copy link
Contributor

@chowbao chowbao commented May 13, 2024

Updates to the README

@chowbao chowbao requested a review from sydneynotthecity May 13, 2024 16:53
Copy link
Contributor

@sydneynotthecity sydneynotthecity left a comment

Choose a reason for hiding this comment

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

Couple suggestions to fix

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated
- Test data should be stored in the `testdata/new_data_structure` folder
- `new_data_structure.go` in the `internal/input` folder
- This file will contain the methods needed to extract the new data structure from wherever it is located. This may be the history archives, the bucket list, or a captive core instance.
- This file should extract the data and transform it, and return the transformed data.
Copy link
Contributor

Choose a reason for hiding this comment

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

we're not actually transforming data in internal/input. This should move under internal/transform

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think technically ledgers and assets does do a small transformation (LCM to the history archive struct for changes). But you're right we shouldn't be doing this and this should only be extracting data and the transforms should happen in the transform dir

Copy link
Contributor

@sydneynotthecity sydneynotthecity left a comment

Choose a reason for hiding this comment

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

LGTM

@chowbao chowbao merged commit d741725 into master May 16, 2024
6 checks passed
@sydneynotthecity sydneynotthecity deleted the update-readme branch July 15, 2024 13:01
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.

2 participants