script-samples icon indicating copy to clipboard operation
script-samples copied to clipboard

Automatic checks on submission

Open pkbullock opened this issue 2 years ago • 2 comments

Need to automate the checks. Eg

  • Files are in expected locations and right casing
  • key files, README.md, in assets, preview.png and sample.json
  • sample.json must not be default BUT if it is to support the contributor, its a task for ME.
  • Parts of the Readme needed to be updated (need to expand on detail)
  • telemetry url in right format matches the folder name
  • delete cmdlet have warning in place in the readme file
  • dates are up to date - ensure that dates created/modified are not part of the default template e.g. there is a change.
  • Recent issue the name column in sample.json file shouldn't contain special characters

Ideally, the list shouldnt be a barrier, its more of a helper for me to tweak the submission accordingly (so i don't miss anything) and contributor gets help.

  • For each step thats checked - ensure there is contributor guidance to help the contributor.

pkbullock avatar Dec 14 '23 17:12 pkbullock

Hi @hugoabernier - the submission checker you have built for other repos, I am looking to do the above. Highlighting here at some point we should connect and see if your tool can do the above. 😁

pkbullock avatar Apr 12 '25 09:04 pkbullock

We can definitely do this.

Here what I think we can do right away vs needing more deets

  • [x] Files are in expected locations and right casing

    will need more details, but most likely achievable with mod filter expressions

  • [x] key files, README.md, in assets, preview.png and sample.json

    assuming any *.png file under assets folder. We can tweak rules to request preview.png specifically

  • [x] sample.json must not be default BUT if it is to support the contributor, its a task for ME.

    I use a PowerShell script to populate/update the sample.json

  • [ ] Parts of the Readme needed to be updated (need to expand on detail)

    Would love more details on what to check for

  • [x] telemetry url in right format matches the folder name

    I use PowerShell to update the README.md based on folder name

  • [ ] delete cmdlet have warning in place in the readme file

    Need more details, but sounds fun!

  • [x] dates are up to date - ensure that dates created/modified are not part of the default template e.g. there is a change.

    I use PowerShell to updated the sample.json dates based on earliest/latest dates in the version history table in the README.md

  • [ ] Recent issue the name column in sample.json file shouldn't contain special characters

    Need more details here

hugoabernier avatar Apr 13 '25 16:04 hugoabernier