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

Feat/getting started guide #383

Open
wants to merge 11 commits into
base: dev
Choose a base branch
from
Open

Feat/getting started guide #383

wants to merge 11 commits into from

Conversation

pbelmann
Copy link
Member

This PR represents a rewrite of the Getting Started section.

  • Quickstart and Getting Started can by followed without checking out the git repository
  • Getting Started section explains not only how to run the Toolkit on a cloud-based cluster but also how to add an analysis and how to exchange a tool of a module.
  • All Getting Started scripts are part of the Github Action tests.

PR review guidelines

Thank you for submitting this PR.

Before merge:

  • A PR must be reviewed by one of the team members.

  • Please check if anything in the documentation must be adjusted, or added (development-setup, production-setup, user-guide).

  • PRs with new modules or workflow interfaces must include tests according to the developer guidelines.

  • The new code is readable, well commented and should adhere to our developer guidelines.

  • Before merging it must be checked if a squash of commits is required.

Config updates

If you update any of the config files in the default folder, please make sure to also update the clowm/nextflow_schema.json if necessary.

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.

1 participant