Skip to content

feat: Common contribution guidelines - #154

Open
fellen31 wants to merge 15 commits into
devfrom
common-contribution-guidelines
Open

feat: Common contribution guidelines#154
fellen31 wants to merge 15 commits into
devfrom
common-contribution-guidelines

Conversation

@fellen31

@fellen31 fellen31 commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Closes https://github.com/Clinical-Genomics/MTP-oncoflow/issues/85. The PR that will be generated: #155.

Added

Changed

  • Changed .nf-core.yml to allow for template strings in contribution guidelines sync workflow

@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown

PR checklist

  • Fill in description of the PR and link to any relevant issues.
  • If you've fixed a bug, added a subworkflow or any other code that should be tested, add tests!
  • If you've added a new tool, update citations according to the instructions under Adding Citations.
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • README.md is updated (including authors/contributors).

See Contributing Guidelines for more details on how to contribute according to pipeline conventions.

@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown

nf-core pipelines lint overall result: Failed ❌

Posted for pipeline commit 6f31d58

+| ✅ 193 tests passed       |+
#| ❔  21 tests were ignored |#
#| ❔   1 tests had warnings |#
!| ❗  12 tests had warnings |!
-| ❌   1 tests failed       |-
Details

❌ Test failures:

  • modules_json - Your modules.json file is outdated. It will be automatically generated by running any module command.

❗ Test warnings:

  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in README.md: Include a figure that guides the user through the major workflow steps. Many nf-core
  • pipeline_todos - TODO string in README.md: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file.
  • pipeline_todos - TODO string in nextflow.config: Optionally, you can add a pipeline-specific nf-core config at https://github.com/nf-core/configs
  • pipeline_todos - TODO string in nextflow.config: Update the field with the details of the contributors to your pipeline. New with Nextflow version 24.10.0
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
  • pipeline_todos - TODO string in nextflow.config: Specify any additional parameters here
  • pipeline_todos - TODO string in test_full.config: Specify the paths to your full test data ( on nf-core/test-datasets or directly in repositories, e.g. SRA)
  • pipeline_todos - TODO string in test_full.config: Give any required params for the test so that command line flags are not needed
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes
  • pipeline_todos - TODO string in base.config: Customise requirements for specific processes.
  • schema_lint - Parameter input not found in schema

❔ Tests ignored:

❔ Tests fixed:

✅ Tests passed:

Run details

  • nf-core/tools version 4.0.2
  • Run at 2026-07-09 11:29:16

Comment thread .github/workflows/sync-guidelines.yml Outdated
@fellen31
fellen31 marked this pull request as ready for review July 1, 2026 13:43
@fellen31
fellen31 requested a review from a team as a code owner July 1, 2026 13:43
@fellen31
fellen31 marked this pull request as draft July 2, 2026 07:54
Comment thread assets/contribution-guidelines-config.yaml
Comment thread assets/contribution-guidelines-config.yaml
Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md Outdated
Comment thread .nf-core.yml Outdated
multiqc_config: false
nextflow_config:
- params.input
template_strings:

@beatrizsavinhas beatrizsavinhas Jul 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you explain what these template_strings are about? Or point me to the nf-core documentation because I couldn't find it... 🤔

@fellen31 fellen31 Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since nf-core also use jinja for their template string, this linting check is there to make sure that there are no template strings left in the template (which could mean a broken template): https://nf-co.re/tools/docs/4.0.2/pipeline_lint_tests/template_strings.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! And the README of genomic-medicine-sweden/nf-dev-guidelines already includes information on this too - great!!!

However, I don't see any such strings in the config file? Am I missing something? 🤔

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it was probably an artifact from an older version. There should be no template strings in the config.

fellen31 and others added 3 commits July 2, 2026 14:22
Co-authored-by: Beatriz Vinhas <beatriz.sa.vinhas@gmail.com>
Co-authored-by: Beatriz Vinhas <beatriz.sa.vinhas@gmail.com>
Co-authored-by: Beatriz Vinhas <beatriz.sa.vinhas@gmail.com>
@fellen31
fellen31 marked this pull request as ready for review July 2, 2026 13:50
@fellen31
fellen31 requested a review from beatrizsavinhas July 6, 2026 12:41
fellen31 pushed a commit to genomic-medicine-sweden/nf-dev-guidelines that referenced this pull request Jul 9, 2026
As discussed in
Clinical-Genomics/oncorefiner#154 (comment),
it is more intuitive if the config file is named
`contribution-guidelines-config.yaml`.
Comment thread .nf-core.yml Outdated
nextflow_config:
- params.input
template_strings:
- assets/nf-dev-guidelines.yaml

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update file path.

Removed template_strings configuration from nextflow_config.
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 this pull request may close these issues.

2 participants