Skip to content

Add developer contribution docs page#694

Open
jfy133 wants to merge 8 commits intodevfrom
add-developer-page
Open

Add developer contribution docs page#694
jfy133 wants to merge 8 commits intodevfrom
add-developer-page

Conversation

@jfy133
Copy link
Member

@jfy133 jfy133 commented Feb 20, 2026

This is what I use to make sure nothing is missing :)

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/taxprofiler branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@github-actions
Copy link

github-actions bot commented Feb 20, 2026

This PR is against the master branch ❌

  • Do not close this PR
  • Click Edit and change the base to dev
  • This CI test will remain failed until you push a new commit

Hi @jfy133,

It looks like this pull-request is has been made against the nf-core/taxprofiler master branch.
The master branch on nf-core repositories should always contain code from the latest release.
Because of this, PRs to master are only allowed if they come from the nf-core/taxprofiler dev branch.

You do not need to close this PR, you can change the target branch to dev by clicking the "Edit" button at the top of this page.
Note that even after this, the test will continue to show as failing until you push a new commit.

Thanks again for your contribution!

@jfy133 jfy133 changed the base branch from master to dev February 20, 2026 10:09
@github-actions
Copy link

github-actions bot commented Feb 20, 2026 •
edited
Loading

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit afed3a6

+| ✅ 290 tests passed       |+
!| ❗  18 tests had warnings |!
Details

❗ Test warnings:

  • files_exist - File not found: conf/igenomes.config
  • files_exist - File not found: conf/igenomes_ignored.config
  • pipeline_todos - TODO string in nextflow.config: Specify any additional parameters here
  • local_component_structure - kraken2_standard_report.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - krona_cleanup.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - shortread_preprocessing.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - nonpareil.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_adapterremoval.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_filtering.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_fastp.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - visualization_krona.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_preprocessing.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_adapterremoval.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_hostremoval.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_hostremoval.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - profiling.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - standardisation_profiles.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_complexityfiltering.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure

✅ Tests passed:

Run details

  • nf-core/tools version 3.5.2
  • Run at 2026-03-01 14:52:36

@jfy133
Copy link
Member Author

jfy133 commented Feb 20, 2026

@nf-core-bot fix linting

jfy133
jfy133 commented Feb 20, 2026
View reviewed changes
jfy133
jfy133 commented Feb 20, 2026
View reviewed changes
@github-actions github-actions bot added the size/m label Mar 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sofstam sofstam Awaiting requested review from sofstam sofstam is a code owner

@LilyAnderssonLee LilyAnderssonLee Awaiting requested review from LilyAnderssonLee LilyAnderssonLee is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

size/m size/s

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@jfy133