Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

46 lines (29 loc) · 1.34 KB
Raw

Contributing to nf-modules

Create a new module with:

nf-core modules create

Follow the prompts to name the module, set author information, etc. Then edit the meta.yml and main.nf files as needed.

Unit tests

Once you've written or updated a module under modules/CCBR/[module-name] and a test workflow under tests/modules/CCBR/[module-name], then use nf-core tools to automatically create a test YAML file with:

nf-core modules create-test-yml [module-name] --run-tests --force --no-prompts

Add the module to tests/config/pytest_modules.yml

Run the tests with:

PROFILE=docker nf-core modules test [module-name] --no-prompts

Pre-commit hooks

Pre-commit can automatically format your code, check for spelling errors, etc. every time you commit.

Install pre-commit if you haven't already, then run pre-commit install to install the hooks specified in .pre-commit-config.yaml. Pre-commit will run the hooks every time you commit.

Changelog

Keep the changelog up to date with all notable changes in CHANGELOG.md1.

VS code extensions

If you use VS code, installing nf-core extension pack is recommended.

Footnotes

  1. changelog guidelines: https://keepachangelog.com/en/1.1.0/ ↩