Add readme check #2955
Merged
Add readme check #2955
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…xamples into add-readme-check
…xamples into add-readme-check
…automl-standalone-jobs/cli-automl-forecasting-task-github-dau
diondrapeck
requested review from
sdgilley,
msakande,
Blackmist,
ssalgadodev,
lgayhardt and
fbsolo-ms1
as code owners
sdgilley
reviewed
Jan 17, 2024
I re-opened the previous PR but addressed the notebooks that were failing. I figured out the issue, so we can discuss in our meeting. Thanks for reviewing! |
|
I've confirmed these changes don't break the azure-docs-pr build using learn-validation in VSCode. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a step to the CI which will check that each sample folder has a README file following the README template to ensure that all samples are descriptive enough for users to easily understand their purpose and if they're relevant. To start, all sample directories without README files will be placed into an excluded list and bypassed, but all owners of such samples will be contacted and asked to provide READMEs.
Checklist