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 README #33

Merged
merged 11 commits into from
Mar 7, 2024
Merged

Add README #33

merged 11 commits into from
Mar 7, 2024

Conversation

sorelfitzgibbon
Copy link
Collaborator

@sorelfitzgibbon sorelfitzgibbon commented Mar 6, 2024

Description

README has been completed with the exception of the PlantUML flow chart and the Testing and Validation sections which will be completed in a separate PR.

Closes #5

Checklist

  • I have read the code review guidelines and the code review best practice on GitHub check-list.

  • I have reviewed the Nextflow pipeline standards.

  • The name of the branch is meaningful and well formatted following the standards, using [AD_username (or 5 letters of AD if AD is too long)]-[brief_description_of_branch].

  • I have set up or verified the branch protection rule following the github standards before opening this pull request.

  • I have added my name to the contributors listings in the manifest block in the nextflow.config as part of this pull request, am listed
    already, or do not wish to be listed. (This acknowledgement is optional.)

  • I have added the changes included in this pull request to the CHANGELOG.md under the next release version or unreleased, and updated the date.

  • I have updated the version number in the metadata.yaml and manifest block of the nextflow.config file following semver, or the version number has already been updated. (Leave it unchecked if you are unsure about new version number and discuss it with the infrastructure team in this PR.)

  • I have tested the pipeline on at least one A-mini sample.

@sorelfitzgibbon
Copy link
Collaborator Author

Ready for review

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@yashpatel6 yashpatel6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! We can update as more tools are added

@sorelfitzgibbon sorelfitzgibbon merged commit 0bb40e4 into main Mar 7, 2024
1 check passed
@sorelfitzgibbon sorelfitzgibbon deleted the sfitz-add-readme branch March 7, 2024 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

write README
2 participants