Skip to content

Commit aa23562

Browse files
Merge pull request #18 from snakemake-workflows/docs-add-catalog-update-template-info
add snakemake catalog infos and update template infos
2 parents a9eefc1 + 80ea5d7 commit aa23562

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ Contributing is easy:
4040
### Guidelines
4141

4242
1. A workflow repository shall consist of one Snakemake workflow.
43-
2. The structure of the workflow should follow our [template](https://github.com/snakemake-workflows/cookiecutter-snakemake-workflow). You can create a new workflow with [cookiecutter](https://github.com/audreyr/cookiecutter) via `cookiecutter gh:snakemake-workflows/cookiecutter-snakemake-workflow`.
43+
2. The structure of the workflow should follow our [template](https://github.com/snakemake-workflows/snakemake-workflow-template). You can create a new workflow from it by [clicking the `Use this template` button](https://github.com/snakemake-workflows/snakemake-workflow-template/generate) on the template repositories page. And just follow the TODOs from there.
4444
3. Whenever possible, [Snakemake wrappers](https://snakemake-wrappers.readthedocs.io) should be used.
4545
4. The workflow should be configurable via a well documented YAML-based configuration file and (when necessary) a sample and a unit sheet (see [here](https://github.com/snakemake-workflows/rna-seq-star-deseq2) for an example).
4646
5. The workflow has to define an (integration-style) test case that is configured via the `.travis.yml` file in the skeleton.
47+
6. For inclusion in the [snakemake workflow catalog](https://snakemake.github.io/snakemake-workflow-catalog/), further follow [the catalog inclusion requirements](https://snakemake.github.io/snakemake-workflow-catalog?rules=true).

0 commit comments

Comments
 (0)