Skip to content

Docs/jl/readme content#158

Draft
JuliaLienard wants to merge 10 commits into
mainfrom
docs/jl/README_content
Draft

Docs/jl/readme content#158
JuliaLienard wants to merge 10 commits into
mainfrom
docs/jl/README_content

Conversation

@JuliaLienard

@JuliaLienard JuliaLienard commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Summary

Creation of the README content and its associated documentation files.


Type of change

  • Bug fix
  • Patch / hotfix
  • New feature / enhancement
  • Refactor / cleanup
  • Documentation update

Checklist (author)

  • CHANGELOG updated with a clear entry
  • Version bumped in configs/nextflow.hopper.config (if user-facing change, skip if it is an infra only)
  • Pipeline runs successfully on stubs (-profile test or equivalent)
  • Outputs validated (VCFs, metrics, reports, MultiQC if applicable)
  • Output from affected processes inspected (.command.sh, .command.log, .command.err, result files in work/)
  • New data formats tested for compatibility with Coyote3
  • New data formats tested for compatibility with GENS
  • Documentation updated (README, params, examples, usage)
  • Containers / tools updated are version-pinned and reproducible
  • At least one reviewer has tested and approved the code

Breaking changes

  • No breaking changes
  • Params/outputs/configs changed (list details in Summary)
  • Output filenames or structure changed (document migration path)

Testing performed

Describe what was tested, datasets/profiles used, and results. Attach logs or links if helpful.

Performed by:

  • Viktor
  • Ram
  • Sailedra
  • Julia

(Add if missing)


Notes for reviewers

Mention risk areas, edge cases, or anything needing special attention.


Review performed by

  • Viktor
  • Ram
  • Sailedra

(Add if missing)


Release notes (draft)

Short, user-facing bullet points for the next release tag.

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.

1 participant