nf-core / nf-core/tools

Refactor pipeline emails

Open
#112 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

infrastructure template
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

The onComplete email code was written before nextflow had native support. It adds loads of boiler plate code to every pipeline which can be almost entirely removed now.

Needs refactoring, and quite a bit of testing. We want to try to keep as much of the email contents the same if possible, which may require some PRs to core nextflow.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by locating the pipeline onComplete email implementation and its existing tests, then compare it with native Nextflow email support. Done means removing redundant boilerplate, preserving email contents where possible, adding substantial test coverage, and identifying any required core Nextflow changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.