You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Although one can find detailed documentation on how to submit a PR for a new or updated rock-on in the README.md file, it remains unclear for a contributor what the guidelines for formatting the JSON file are, or what information should be included.
Although this can be partially automated (see #91), one could use Github PR templates to help the contributor prepare the best PR submission possible. This would help alleviate the work required in common edits prior to PR merge and thus greatly accelerate the successful PR process.
One could thus provide a checklist for the contributor to:
provide the contributor with additional pointers to make sure the included docker image(s) fit general guidelines (when appropriate)
ensure the JSON file was verified to be valid
ensure the required information is provided with pointers on where it should be. For instance, is the link to the docker hub image included in the "description" object?
ensure an entry was added to the root.json file (when applicable)
One could also add template to make sure the information required by reviewer(s) is provided:
project name and link to project
image used with link to docker hub
benefits of this rock-on to the Rockstor community: improvement(s) on existing rock-on, addresses a current need, "better" image used, etc...
The list above is of course only a suggestion and can easily be improved as needed.
The text was updated successfully, but these errors were encountered:
Although one can find detailed documentation on how to submit a PR for a new or updated rock-on in the README.md file, it remains unclear for a contributor what the guidelines for formatting the JSON file are, or what information should be included.
Although this can be partially automated (see #91), one could use Github PR templates to help the contributor prepare the best PR submission possible. This would help alleviate the work required in common edits prior to PR merge and thus greatly accelerate the successful PR process.
One could thus provide a checklist for the contributor to:
"description"
object?root.json
file (when applicable)One could also add template to make sure the information required by reviewer(s) is provided:
The list above is of course only a suggestion and can easily be improved as needed.
The text was updated successfully, but these errors were encountered: