Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

No template for new PRs #194

Closed
FroggyFlox opened this issue Oct 14, 2019 · 0 comments · Fixed by #196
Closed

No template for new PRs #194

FroggyFlox opened this issue Oct 14, 2019 · 0 comments · Fixed by #196

Comments

@FroggyFlox
Copy link
Member

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:

  1. provide the contributor with additional pointers to make sure the included docker image(s) fit general guidelines (when appropriate)
  2. ensure the JSON file was verified to be valid
  3. 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?
  4. 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:

  1. project name and link to project
  2. image used with link to docker hub
  3. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant