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

Polish workflow and make it reproducible using toy data #6

Merged
merged 16 commits into from
Dec 8, 2023

Conversation

maurolepore
Copy link
Contributor

@maurolepore maurolepore commented Dec 7, 2023

Relates to #1

This PR:

  • Makes the workflow reproducible by using toy data, and writing outputs under ~/Downloads.
  • Makes names consistent with existing names in profile_*() arguments or tiltToyData.
  • Makes the text easier to maintain by removing brittle references to names/numbers that will likely change. For example, saying this works with "all the four indicators" is brittle. It will become obsolete when we add a fifth indicator. Also references to tiltIndicatorBefore are brittle, as that's a poor name (my bad idea) and is likely to change.
  • Shows results so the user can see what the output looks like without needing to run this workflow.

TODO

  • Link related issue/PR.
  • Describe the goal of the PR. Avoid details that are clear in the diff.
  • Mark the PR as draft.
  • Include a unit test.
  • Review your own PR in "Files changed".
  • Ensure the PR branch is updated.
  • Ensure the checks pass.
  • Change the status from draft to ready.
  • Polish the PR title and description.
  • Assign a reviewer.

EXCEPTIONS

  • Slide here any item that you intentionally choose to not do.

@maurolepore maurolepore marked this pull request as ready for review December 7, 2023 16:15
@maurolepore maurolepore changed the title Make workflow reproducible Polish workflow and make it reproducible using toy data Dec 7, 2023
@maurolepore maurolepore closed this Dec 7, 2023
@maurolepore maurolepore deleted the make-reproducible branch December 7, 2023 22:56
@maurolepore maurolepore restored the make-reproducible branch December 8, 2023 06:50
@maurolepore maurolepore reopened this Dec 8, 2023
@maurolepore maurolepore merged commit 26d5041 into main Dec 8, 2023
@maurolepore maurolepore deleted the make-reproducible branch December 8, 2023 13:39
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