Merge pull request #63 from matrulda/update_contribution_guidelines_regarding_displaying_results

Update CONTRIBUTION regarding displaying tool results

Author: FranBonath

.github/CONTRIBUTING.md

@@ -82,6 +82,12 @@ If you wish to contribute a new step, please use the following coding standards:
 9. Update MultiQC config `assets/multiqc_config.yml` so relevant suffixes, file name clean up and module plots are in the appropriate order. If applicable, add a [MultiQC](https://https://multiqc.info/) module.
 10. Add a description of the output files and if relevant any appropriate images from the MultiQC report to `docs/output.md`.
 
+### Things to consider regarding displaying results for a new tool
+
+- If a MultiQC module exist for the tool, use the standard settings for it to start with.
+- If no Multiqc module exists, the results of the tool should be made available in the results directory.
+- If a tool doesn’t produce output files, the stdout should be channeled into a output file that can be accessible from the outdir of the pipeline.
+
 ### Default values
 
 Parameters should be initialised / defined with default values in `nextflow.config` under the `params` scope.

.nf-core.yml

@@ -1,5 +1,7 @@
 bump_version: null
-lint: null
+lint:
+  files_unchanged:
+    - .github/CONTRIBUTING.md
 nf_core_version: 3.0.2
 org_path: null
 repository_type: pipeline

CHANGELOG.md

@@ -13,6 +13,7 @@ Initial release of nf-core/seqinspector, created with the [nf-core](https://nf-c
 - [#13](https://github.com/nf-core/seqinspector/pull/13) Generate reports per run, per project and per lane.
 - [#49](https://github.com/nf-core/seqinspector/pull/49) Merge with template 3.0.2.
 - [#51](https://github.com/nf-core/seqinspector/pull/51) Add nf-test to CI.
+- [#63](https://github.com/nf-core/seqinspector/pull/63) Contribution guidelines added about displaying results for new tools
 
 ### `Fixed`