How to Contribute with a Research Framework

Register an actively-developed open source workflow-related research frameworks

All Research Frameworks

The Workflows Community Initiative (WCI) provides a curated collection of open source or freely accessible tools and frameworks that can be used to support workflow research and development. The main goal of this collection is to showcase workflow system capabilities developed by the community. We invite all workflow researchers to share their tools and frameworks through this collection.

Adding a Workflow Research Framework

To add a workflow research framework, you only need to add the framework information into an YAML file hosted as part of the WCI GitHub repository. The preferred way to submit your changes is via creating a pull request with the changes. To this end, these are the recommended steps for adding a workflow research framework:

  1. Fork the WCI GitHub repository
  2. Clone your forked repository:
    git clone https://github.com/<your_username>/workflowscommunity.github.io
  3. Edit the _data/research_frameworks.yml file, and add the information regarding the workflow research framework:
    - name: "Research Framework Name"
      url: <framework_url>
      description: "Short framework description" 
      icon: <url_to_framework_logo> # square images are preferred (1:1 aspect ratio)
      github: <url_to_github_repository> # do not provide if hosted at GitLab
      gitlab: <url_to_gitlab_repository> # do not provide if hosted at GitHub
      documentation: <documentation_url> # optional
      tags: # optional: provide up to 5 tags
        - my_tag_1
        - my_tag_2
                      
  4. Commit the changes, and create a pull request for the WCI GitHub repository.
  5. The WCI team will then evaluate your pull request, and merge the changes if the workflow research framework and examples are properly documented.