Skip to content

Commit

Permalink
Merge pull request #632 from mvdbeek/focus_on_production_workflows
Browse files Browse the repository at this point in the history
Clarify that IWC aims to provide production workflows
  • Loading branch information
mvdbeek authored Dec 12, 2024
2 parents a5ef766 + 0197b23 commit 9a47001
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ FOR CONTRIBUTOR:

FOR REVIEWERS:
* [ ] .dockstore.yml: file is present and aligned with creator metadata in workflow. ORCID identifiers are strongly encouraged in creator metadata. The .dockstore.yml file is required to run tests
* [ ] Workflow is sufficiently generic to be used with lab data and does not hardcode sample names, reference data and can be run without reading an accompanying tutorial.
* [ ] In workflow: annotation field contains short description of what the workflow does. Should start with `This workflow does/runs/performs … xyz … to generate/analyze/etc …`
* [ ] In workflow: workflow inputs and outputs have human readable names (spaces are fine, no underscore, dash only where spelling dictates it), no abbreviation unless it is generally understood. Altering input or output labels requires adjusting these labels in the the workflow-tests.yml file as well
* [ ] In workflow: `name` field should be human readable (spaces are fine, no underscore, dash only where spelling dictates it), no abbreviation unless generally understood
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ All IWC workflows are automatically installed onto usegalaxy.* servers (i.e. [Ga

## Contributing a Workflow

Anyone can contribute a Galaxy Workflow. Please check out the [Adding workflow guidelines](workflows/README.md#adding-workflows).
Anyone can contribute a production Galaxy Workflow. Please check out the [Adding workflow guidelines](workflows/README.md#adding-workflows).

If linting passes, tests pass, and human review passes, the PR is merged and

Expand Down
11 changes: 11 additions & 0 deletions workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,17 @@ The structure is as follows:

## Adding workflows

### Workflow eligibility

We want to collect production workflows targeted at users that want to analyze their own data.
As such, the workflow should be sufficiently generic that users can provide their own data.

We encourage, but do not require, links to related [Galaxy Training Network Tutorials](https://training.galaxyproject.org/).
Importantly, each workflow should be described in a way that a user can run the
workflow on their own data without modifying the workflow. If you wish to
deposit a workflow that accompanies a tutorial please make sure that the workflow
does not refer to datasets that only make sense in the context of the tutorial.

Here are some guidelines to help new contributors to add their workflows.

Everything starts from a workflow that you have on a galaxy instance.
Expand Down

0 comments on commit 9a47001

Please sign in to comment.