Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

47 lines (29 loc) · 2.82 KB
Raw

nf-core/modules: Contributing Guidelines

Hi there! Many thanks for taking an interest in improving nf-core/modules.

We try to manage the required tasks for nf-core/modules using GitHub issues, you probably came to this page when creating one. Please use the pre-filled template to save time.

However, don't be put off by this template - other more general issues and suggestions are welcome! Contributions to the code are even more welcome ;)

If you need help using or modifying nf-core/modules then the best place to ask is on the nf-core Slack #modules channel (join our Slack here).

Contribution workflow

If you'd like to write some code for nf-core/modules, the standard workflow is as follows:

  1. Check that there isn't already an issue about your idea in the nf-core/modules issues to avoid duplicating work
  • If there isn't one already, please create one so that others know you're working on this
  1. Fork the nf-core/modules repository to your GitHub account
  2. When adding a module file, follow the guidelines
  3. Ensure that tests are working locally
  4. Submit a Pull Request against the master branch and wait for the code to be reviewed and merged

If you're not used to this workflow with git, you can start with some docs from GitHub or even their excellent git resources.

Tests

When you create a pull request with changes, GitHub Actions will run automatic tests. Typically, pull-requests are only fully reviewed when these tests are passing, though of course we can help out before then.

Module tests

Each nf-core/module should be set up with a minimal set of test-data. GitHub Actions then runs the module on this data to ensure that it exits successfully. If there are any failures then the automated tests fail. These tests are run both with the latest available version of Nextflow and also the minimum required version that is stated in the pipeline code.

Getting help

For further information/help, please consult the nf-core/modules README and don't hesitate to get in touch on the nf-core Slack #modules channel (join our Slack here).

Images and figures

For overview images and other documents we follow the nf-core style guidelines and examples.