Contributing to Streamdal

We're updating our documentation, so the presented info might not be the most recent.

Streamdal is an open-source project using the Apache License, Version 2.0. Feature proposals and general contributions are cherished and highly encouraged! Most of the components can be found in the monorepo.

Here is the repo structure:

# ├── apps
# │   ├── cli                <--- CLI UI 
# │   ├── console            <--- Web-based UI
# │   ├── docs               <--- https://docs.streamdal.com 
# │   ├── server             <--- Server component
# │   └── ...
# ┌── assets                 <--- Static assets 
# │   ├── img
# │   └── ...
# ├── docs
# │   ├── install             <--- different methods of deploying/installing Streamdal
# │   ├── instrument          <--- instrumenting Streamdal in various languages
# |   └── ...
# ├── libs
# │   ├── protos             <--- Common protobuf schemas
# │   ├── wasm-detective     <--- Wasm lib used for data parsing and validation 
# │   ├── wasm-transformer   <--- Wasm lib used for data transformation
# │   ├── wasm               <--- Wasm funcs used in pipeline steps
# │   └── ...
# ├── scripts                   
# │   ├── install
# │   │	  └── install.sh     <--- Install script for installing Streamdal
# │   └── ...
# ├── sdks                   
# │   ├── go                 <--- Golang SDK
# │   ├── node               <--- Node SDK
# │   ├── python             <--- Python SDK
# │   ├── ruby               <--- Ruby SDK
# │   └── ...
# ├── LICENSE
# ├── Makefile               <--- Makefile with common tasks; run `make help` for more info
# └── README.md

General Guidelines & References

New to open source?

Be sure to check for some good first issues periodically.

Here are some references and simple guidelines you should go over to help ensure contributions go smoothly:

1. The Code of Conduct

2. Streamdal technology stack:

   • Wasm

   • Protobuf

   • gRPC + gRPC-web

   • Rust

   • Go

   • React

   • Flowbite

   • Deno

   • Redis

   • Envoy

   • …and many more open source libraries and tools

     Check out our open source page to learn more about what other technologies are used with Streamdal.

3. The Streamdal manifesto - this should help you gauge where our mindset is focused when it comes to future development

4. Public roadmap

Getting support:
We primarily provide support for issues through the main monorepo. To bring more visibility to your issue, or for quick questions, ask in the community discord.

Adding an Issue

Before adding issues, you should:

1. Be familiar with the core components
2. Search for existing issues

Issues for components outside of the monorepo, like language-specific shims or client SDKs, should be made in those specific repositories. You can find these listed above, on the monorepo README.md, or by searching through the Streamdal public repositories.

Formatting

We utilize conventional commits to structure issues.

You should format the name of your issue as close as possible to the following examples:

• feat: <description> — The type feat introduces a new feature to the codebase. Use this for proposals as well. (This can be/is sometimes marked as chore)
• fix: <description> — You’ve found a bug with the code and want to report it, or create an issue to track the bug.
• discussion: <description> — You have something on your mind, which requires input from others in a discussion. This could pertain to niche deployments, edge use cases not well documented, or anything else that might be relevant. Use this for questions as well.

Component Versions

Issues should always list (where applicable) the version of everything you are using.

If you’re using docker-compose, you can check the docker-compose.yml for versions, else you can do the following for each component:

• Server:

  You can curl the version from the server REST API endpoint by adding /version:




curl http://streamdal.server:8081/version




• SDK:

  This is language specific. You can find this in /releases of the URL (Replace $lang with the language you are using):




https://github.com/streamdal/streamdal/tree/main/sdks/$lang

Note: Since moving to the monorepo, the releases have changed. More info will be added here about listing SDK version soon!

• Console UI:

  cat the version.ts file located in the root directory where the Console UI is running. It is also visually indicated at the bottom left corner of the UI:





Open in new tab ⇱

3. Include a thorough description of what your code does inside the PR. Preferably, include a screenshot if it applies.

If you feel it necessary, or for some reason an important issue is going unnoticed, you are also permitted to cross-post issues to the community for greater visibility.

Pull Requests

All contributions come through pull requests. Follow these guidelines when contributing code or docs to Streamdal:

1. Make sure there’s an issue (fix or feat) raised, which sets the expectations for the contribution you are about to make
2. Clone relevant repo and create a new branch
3. Create your change — Code changes require tests, and make sure to run linters to check and format the code
4. Update relevant documentation for the change - Please check the doc’s README for helpful information on contributing to docs
5. Commit with DCO sign-off and open a PR
6. Wait for the CI process to finish and make sure all checks are green. A maintainer of the project will be assigned, and you can expect a review within a few days

Any contribution that you make to Streamdal repositories will be under the Apache 2.0 License, as dictated by that license:

5. Submission of Contributions. Unless You explicitly state otherwise, any 
Contribution intentionally submitted for inclusion in the Work by You to the 
Licensor shall be under the terms and conditions of this License, without any 
additional terms or conditions. Notwithstanding the above, nothing herein shall 
supersede or modify the terms of any separate license agreement you may have 
executed with the Licensor regarding such Contributions.

Work-in-progress

A good way to communicate before investing too much time is to create a “Work-in-progress” PR and share it with your reviewers. The standard way of doing this is to add a “[WIP]” prefix in your PR’s title and assign the do-not-merge label. This will let people looking at your PR know that it is not well baked yet.

Developer Certificate of Origin: Signing your work

Every commit needs to be signed

The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the DCO, reformatted for readability:

By making a contribution to this project, I certify that:

    (a) The contribution was created in whole or in part by me and I have the 
    right to submit it under the open source license indicated in the file; or

    (b) The contribution is based upon previous work that, to the best of my 
    knowledge, is covered under an appropriate open source license and I have 
    the right under that license to submit that work with modifications, 
    whether created in whole or in part by me, under the same open source 
    license (unless I am permitted to submit under a different license), as 
    indicated in the file; or

    (c) The contribution was provided directly to me by some other person who 
    certified (a), (b) or (c) and I have not modified it.

    (d) I understand and agree that this project and the contribution are 
    public and that a record of the contribution (including all personal 
    information I submit with it, including my sign-off) is maintained 
    indefinitely and may be redistributed consistent with this project or the 
    open source license(s) involved.

Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages.

<This is my commit message>

Signed-off-by: Random Dev <[email protected]>

Git even has a -s cli flag to append this automatically to your commit message:

git commit -s -m 'This is my commit message'

Each PR is checked whether or not the commits contain a valid Signed-off-by line.

Unsigned commits

Forget to sign the commit? No problem! Just amend your changes, sign them, and force push them:

git checkout <branch-name>
git commit --amend --no-edit --signoff
git push --force-with-lease <remote-name> <branch-name>

Code of Conduct