Community and Support
Sprocket is developed in the open, and there are several places to ask questions, report problems, or get involved.
Getting help
- OpenWDL Slack—the
#sprocketchannel is the best place for general questions and conversation about Sprocket and WDL. - GitHub Issues—for reporting bugs or problems you encounter.
- GitHub Discussions—for broader questions, ideas, and everything else.
Reporting problems and ideas
Which repository an issue belongs in depends on the part of the project it concerns.
stjude-rust-labs/sprocket— thesprocketcommand line tool, the execution engine, and configuration.stjude-rust-labs/wdl— thewdlfamily of crates, including validation and lint rules. New rule ideas are welcome here.stjude-rust-labs/sprocket-vscode— the Visual Studio Code extension.stjude-rust-labs/sprocket.nvim— the Neovim plugin.
Larger design changes are discussed as RFCs in stjude-rust-labs/rfcs. For example, the design of Sprocket's provenance tracking is described in RFC #3.
Contributing
Contributions are welcome. Sprocket has been architected from the beginning to maximize the potential for any interested party to contribute effectively, and the practices that make that possible—no code ownership, required documentation for public members, a common commit message style, CHANGELOG.md entries, and a comprehensive test suite—are described in the philosophy. Start from the contributing guidelines in the repository you want to work on: sprocket for the command line tool and engine, or wdl for the crates.
If you plan to run Sprocket on Windows and hit problems, report the issue—native Windows support is something the project cares about, as described in goal-adjacent.