Add pull request template #617
Merged
Conversation
This file contains 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
mvdbeek
force-pushed
the
pull_request_template
branch
from
5ff172b to
31d298d
Compare
bernt-matthias
approved these changes
Nov 26, 2024
mvdbeek
commented
Nov 28, 2024
| * [ ] Workflow folder: prefer dash (`-`) over underscore (`_`), prefer all lowercase. Folder becomes repository in [iwc-workflows organization](https://github.com/iwc-workflows) and is included in TRS id | ||
| * [ ] Readme explains what workflow does, what are valid inputs and what outputs users can expect. If a tutorial or other resources exist they can be linked. If a similar workflow exists in IWC readme should explain differences with existing workflow and when one might prefer one workflow over another | ||
| * [ ] Changelog contains appropriate entries | ||
| * [ ] Large files (> 100 KB) are uploaded to zenodo and location urls are used in test file |
There was a problem hiding this comment.
Suggested change
| * [ ] Large files (> 100 KB) are uploaded to zenodo and location urls are used in test file | |
| * [ ] Large files (> 100 KB) are uploaded to zenodo and location urls are used in test file | |
| * [ ] No email post job action |
But that should probably go into linting
mvdbeek
commented
Nov 28, 2024
| @@ -0,0 +1,14 @@ | |||
| FOR CONTRIBUTOR: | |||
| * [ ] I have read the [Adding workflows guidelines](https://github.com/galaxyproject/iwc/blob/main/workflows/README.md#adding-workflows) | |||
| * [ ] License permits unrestricted use (educational + commercial) | |||
There was a problem hiding this comment.
We could put that into the IWC profile for the linter (and require one of the licenses offered in the workflow editor)
mvdbeek
commented
Nov 28, 2024
| * [ ] In workflow: `name` field should be human readable (spaces are fine, no underscore, dash only where spelling dictates it), no abbreviation unless generally understood | ||
| * [ ] Workflow folder: prefer dash (`-`) over underscore (`_`), prefer all lowercase. Folder becomes repository in [iwc-workflows organization](https://github.com/iwc-workflows) and is included in TRS id | ||
| * [ ] Readme explains what workflow does, what are valid inputs and what outputs users can expect. If a tutorial or other resources exist they can be linked. If a similar workflow exists in IWC readme should explain differences with existing workflow and when one might prefer one workflow over another | ||
| * [ ] Changelog contains appropriate entries |
There was a problem hiding this comment.
@lldelisle mentioned that we might need to improve the existing linting in planemo
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.
I have recently spent a good amount of time posting various aspects of this on PRs, I hope this will make the whole process a little smoother.
This is what it looks like when you open a PR: