Repository navigation
feat: the submission form collects screenshots, a video and credits - #18
Open
thesprockee wants to merge 1 commit into
Open
thesprockee wants to merge 1 commit into
thesprockee wants to merge 1 commit into
Conversation
Three optional fields plus a rules checkbox that everyone whose work the mod builds on is named in Credits. scripts/submission_fields.py parses them into the shapes schema/entry.schema.json takes (media.screenshots with alt text, media.video, credits), reports a malformed line as an error the author can fix, and warns when Credits is empty. The parsed values are in report.json's facts for the maintainer to copy into the entry on approval. Closes #13 Co-Authored-By: Andrew Bates <a@sprock.io>
This file contains hidden or 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
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.
Closes #13. The form change Spritz asked for after #8.
What
.github/ISSUE_TEMPLATE/submit-mod.yml: optional Screenshots (one per line:https link | what it shows, up to 8), Video (one https link), Credits (one per line:name | what they did | link (optional), up to 20), and a rules checkbox that everyone whose work the mod builds on is named in Credits.scripts/submission_fields.py(new, stdlib): parses those answers into the shapesschema/entry.schema.json(feat: entry schema, validator and CI check for listed mods #8) takes:media.screenshots[{url, alt}],media.video,credits[{name, role, url?}], with the schema's limits. A malformed line is an error the author can fix; an empty Credits is a warning.scripts/inspect_submission.py: reads the three headings, reports the errors, and puts the parsedmediaandcreditsinreport.json's facts, so a maintainer copies them intomods/<id>.jsonon approval.tests/test_submission_fields.py(17 tests) and.github/workflows/submission-fields-tests.yml.Not shown
check()(call the parsers, report, store facts) only run in a real submission, which I haven't made. The tests do prove that every label in the form is a heading the check reads (a form field the check ignores failstest_every_form_field_is_read_by_the_check).schema/entry.schema.jsonbecause that file is in feat: entry schema, validator and CI check for listed mods #8, not onmainyet.inspect_submission.pylike feat: the submission check reads the plugin-release layout #17; they edit different lines (imports at different spots,check()at different places) and merge cleanly: a scratch merge of this branch withinspect-package-layout(feat: the submission check reads the plugin-release layout #17) ran 41 tests OK.Commands run
Mutants (one line changed, tests run, file restored from a saved copy):
Gates from #14 on this branch: title and commits
ok: true.Co-Authored-By: Andrew Bates a@sprock.io