Completing the steps below before visiting WorkflowHub will ensure a user can find, understand, and reuse your workflow. Importantly, it will also save you time later!
1. Create a workflow
2. If you haven’t already, then version control the workflow with git
Add your workflow to a Git enabled repository (e.g. GitHub). This allows easy import into WorkflowHub, and in particular the import of new workflow versions!
3. License the workflow for reuse
Make sure to add a license that allows others to reuse your workflow. This resource can help you choose a license: https://choosealicense.com/
If you are still unsure which open source license to pick, the standard for the Australian BioCommons is Apache 2.0.
4. Document the workflow well
Update documentation so new users can understand what the workflow does, how it does this, and why. There are multiple options for how to document a workflow and include this in WorkflowHub:
- Repository based documentation
- Create a How-to Guide
- Write a standard operating procedure (SOP)
- Use the WorkflowHub description field.
5. Add a standard metadata file
Consider adding a machine-readable standard file format like CITATION.cff or codemeta.json to your workflow repository (e.g. GitHub, or similar). There are wizards for creating these files, so you don’t need to know how to build them yourself.
6. Create a workflow release
Follow the instructions on GitHub to create a workflow release and tag.