Developer Information

Repository Structure

workflow-tools
 |── docs
      |── Contributors_Guide
      |── Users_Guide
      |── _static
      └── figure
 |── recipe
 └── src
      └── uwtools
           |── api
           |── apps
           |── config
                └── formats
           |── drivers
           |── resources
           |── tests
                |── api
                |── config
                     └── formats
                |── drivers
                |── fixtures
                     └── files
                └── utils
           └── utils

Testing

Coming Soon!

Developer Support

Contributor's Guide

Developers should view the `workflow-tools Contributor's Guide for information on how to contribute to the repository.

Questions

Users can get expert help through the GitHub Discussions forum.

Reporting Bugs

It is often a good idea to ask about potential bugs in the GitHub Discussions Q&A Forum, since many “bugs” do not require a code change/fix — instead, the user may be unfamiliar with the system and/or may have misunderstood some component of the system or the instructions, which is causing the problem. If there is a genuine bug, developers are encouraged to search open issues to see if their bug has already been identified. If there is no open issue to address it, users can report the bug by filing a GitHub Issue.

Requesting Features

Users who want to request a feature enhancement or the addition of a new feature can post their suggestion under Enhancements in the UFS Community GitHub Discussions forum. These feature requests will be forwarded to the Earth Prediction Innovation Center (EPIC) management team for prioritization and eventual addition to the Unified Workflow Tools.