Merge requests

1. Linting

nf-core modules lint <software/tool> --dir .

Repeat the above command till you have all errors resolved.

2. Testing

TMPDIR=~ PROFILE=singularity pytest --tag <software/tool> --symlink --keep-workflow-wd --git-aware

3. Staging

git add ./modules/<software_tool> ./tests/modules/<software_tool> ./tests/config/pytest_modules.yml

4. Commit changes

git commit -m "Adding module for <software/tool>. Closes #<issue_number>.

5. Push changes

git push -u origin <software_tool>

6. Create PR

• Go to https://github.com/sanger-tol/nf-core-modules
• Set base branch to sanger-tol/nf-core-modules:main
• Set compare to sanger-tol/nf-core-modules:<software_tool>
• Click on "Create pull request"
• Fill out the template. Please check all boxes that apply, it helps with the review. Fill in Closes #XXX, it helps with automation.

7. The review process is a back and forth collaborative exercise. Once complete, your PR is merged and the issue is closed.

---

8. Create an issue for a new module in nf-core/modules

9. Create a new PR for nf-core/modules

• Go to https://github.com/nf-core/modules/compare
• Click compare across forks
• Set base branch to nf-core/modules:master
• Set compare to sanger-tol/nf-core-modules:<software_tool>
• Click on "Create pull request"
• Fill out the template. Please check all boxes that apply and fill in Closes #XXX.

10. Going through the PR review in nf-core is personal choice. But creating the PR in nf-core/modules ensures you get the credit if this module is further developed. And also allows us to contribute to a community that helps us out.

11. For any questions, concerns or issues, please message either Matthieu (mm49) or Priyanka (ps22). Happy Coding 👩‍💻