Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

37 lines (23 loc) · 1.36 KB

Contributing to Cloudstate

Thank you for contributing to Cloudstate! We welcome contributions from everyone on the internet, and are grateful for even the smallest of fixes!

Setup

  1. Clone the repository:

    git clone https://github.com/freestyle-sh/cloudstate

  2. Go to the project directory:

    cd cloudstate

Organization

Directory Description
runtime The Cloudstate runtime, which is responsible for running the JavaScript and storing the data.
server The Cloudstate server, which is responsible for making the runtime accessible to consumers.
cli The Cloudstate CLI, which is responsible for managing the Cloudstate server.

Getting Started

The place we most want help is testing the runtime. runtime/tests contains our current test suite. If you find any edge cases, or anything we're not testing that we should be, please follow the writing tests to add a test.

Feature Requests

If you have a feature request, please open an issue on the repository. We'd love to hear your ideas!

Contact Us

Join our Discord!