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

Hand-off check/ Documentation Review #11

Open
1 task
MichaelClifford opened this issue Sep 25, 2020 · 2 comments
Open
1 task

Hand-off check/ Documentation Review #11

MichaelClifford opened this issue Sep 25, 2020 · 2 comments
Assignees

Comments

@MichaelClifford
Copy link
Member

MichaelClifford commented Sep 25, 2020

As a team of data scientists, we want to maker sure we know and and are executing on the best practices around documentation and reproducibility. To that end, @Shreyanand will look at the existing repo and identify any documentation gaps @MichaelClifford needs to fill to make the work reproducible based on documentation alone.

Acceptance Criteria:

  • Any additional documentation is created and added to repo
@Shreyanand
Copy link
Member

@MichaelClifford Should we add documentation regarding the diff/sim with the cockpit tool and the testgrid tool flake analysis so that anyone following this doesn't spend time comparing all these?

@MichaelClifford
Copy link
Member Author

Sure, thats sounds like a good idea @Shreyanand, do you want to add it directly to the README or create a separate document?

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

No branches or pull requests

2 participants