Add link to the submitters guide to improve validation errors message - #10776
Add link to the submitters guide to improve validation errors message#10776nvdaes wants to merge 5 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves the validation error output by adding a pointer to the repository’s Submission Guide so submitters can more easily resolve add-on manifest validation failures.
Changes:
- Add a Submission Guide link to the validation error message written to the optional error output file.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| "This add-on submission has validation errors. " | ||
| "Please submit a new version with the errors fixed. " | ||
| "To get help fixing the errors, read the Add-on Manifest Validation section of the [Submission Guide](https://github.com/nvaccess/addon-datastore/blob/master/docs/submitters/submissionGuide.md#add-on-manifest-validation) " | ||
| "Errors:\n- " + "\n- ".join(errors) + "\n\n", |
There was a problem hiding this comment.
did you consider this suggestion?
|
@seanbudd , feel free to review this. |
|
can you also update the error message for an invalid version to specify the format? E.g. change "Manifest value for 'version' is invalid 0.7.6beta9" to "Manifest value for 'version' is invalid 0.7.6beta9. Format must be major.minor or major.minor.patch" |
|
@seanbudd wrote:
Done. Feel free to review this. |
|
pre-commit.ci run |
Issue number
Fixes #10706
Summary of the issue
Sometimes, may be difficult to know how to fix errors when the validation of an add-on shows errors.
Approach
Added a link to the Add-on Manifest Validation section of the Submission Guide.