Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add more details to README.md #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

LilyAnderssonLee
Copy link
Owner

@LilyAnderssonLee LilyAnderssonLee commented Feb 10, 2023

Description

Add some details to README.md

Preparations:

N/A

How to test:

Run in a tmux screen or similar if testing on a large dataset.
N/A

Expected outcome:

  • [] Produced files contain expected values
    N/A

Review:

  • Code reviewed by

PR checklist

Closes #XXX

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If necessary, include test data in your PR.
  • Follow the input/output options guidelines.
  • Add a resource label
  • Use BioConda and BioContainers if possible to fulfil software requirements.
  • Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:
    • PROFILE=docker pytest --tag <MODULE> --symlink --keep-workflow-wd --git-aware
    • PROFILE=singularity pytest --tag <MODULE> --symlink --keep-workflow-wd --git-aware
    • PROFILE=conda pytest --tag <MODULE> --symlink --keep-workflow-wd --git-aware

@LilyAnderssonLee
Copy link
Owner Author

It's good!

@LilyAnderssonLee LilyAnderssonLee added the documentation Improvements or additions to documentation label Feb 10, 2023
@LilyAnderssonLee LilyAnderssonLee self-assigned this Feb 10, 2023
@LilyAnderssonLee LilyAnderssonLee changed the title add more details add more details to README.md Feb 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant