Overview

Contributing

How to contribute to Redelay.

Thank you for contributing to Redelay!

Repository overview

RepoWhat to contribute
redelay/specDocs, examples, spec changes
redelay/go-frameworkGo framework core
redelay/go-eventsGo event transport library
redelay/go-flowdslGo FlowDSL toolchain
redelay/go-modulesGo addon modules
redelay/websiteredelay.com website
redelay/py-frameworkPython framework core — coming soon
redelay/py-eventsPython event library — coming soon
redelay/js-frameworkNode.js framework core — coming soon
redelay/js-eventsNode.js event library — coming soon

Contributing to docs

  1. Fork redelay/spec
  2. Edit files in docs/
  3. Submit a PR against main

The website rebuilds automatically when spec/main is updated.

Contributing to code

  1. Fork the relevant library repo
  2. Create a branch from main
  3. Make changes + tests
  4. Submit a PR

Code style

  • Go: gofmt. Run go vet ./... and make check in infra/ before submitting.
  • Python / Node.js: style guides will be published alongside each SDK's release.

Reporting bugs

Open an issue in the relevant repo. Include:

  • Redelay version
  • Go version (and Python / Node.js version once those SDKs are released)
  • Minimal reproduction case