1- # Contributing to DBSP
1+ # Contributing to Feldera
22
3- The DBSP project team welcomes contributions from the community. Before you start working with DBSP , please
3+ The Feldera team welcomes contributions from the community. Before you start working with Feldera , please
44read our [ Developer Certificate of Origin (DCO)] ( https://developercertificate.org/ ) .
55To acknowledge the DCO, sign your commits by adding ` Signed-off-by: Your Name <your@email.com> ` to the last
66line of each Git commit message. Your signature certifies that you wrote the patch or have the right to pass
@@ -10,8 +10,10 @@ with `git commit -s`.
1010
1111## Dependencies
1212
13- We develop and test under Linux. Windows Subsystem for Linux works fine.
14- The setup can be seen in this [ Earthfile] ( Earthfile ) .
13+ Our team develops and tests using Linux and MacOS. Windows Subsystem for Linux works fine too.
14+
15+ The Feldera container images and CI workflows use Linux. You can see our setup in
16+ our [ Dockerfile] ( deploy/Dockerfile ) and [ Earthfile] ( Earthfile ) .
1517
1618Our known dependencies are:
1719- Runtime
@@ -35,10 +37,10 @@ maven, Python, and typescript build tools.
3537
3638### Forking
3739
38- We recommend forking the dbsp repository and contributing from a fork.
40+ We recommend forking the Feldera repository and contributing from a fork.
3941This [ page] ( https://docs.github.com/en/get-started/quickstart/fork-a-repo )
4042has instructions on how to fork a repository. After forking do not
41- forget to add dbsp as a remote repository:
43+ forget to add Feldera as a remote repository:
4244
4345``` shell
4446git remote add upstream https://github.com/feldera/feldera.git
@@ -52,7 +54,7 @@ This is a rough outline of what a contributor's workflow looks like:
5254- Make commits of logical units
5355- Make sure your commit messages are in the proper format (see below)
5456- Push your changes to a topic branch in the repository (push to your fork if
55- you don't have commit access to the dbsp repository --- pushing directly
57+ you don't have commit access to the Feldera repository --- pushing directly
5658 to the repo is preferred because then CI will be able to add benchmark
5759 results to the PR in the comments).
5860- Submit a pull request
@@ -145,9 +147,9 @@ When opening a new issue, try to roughly follow the commit message format conven
145147
146148# For developers
147149
148- ## Building DBSP from sources
150+ ## Building Feldera from sources
149151
150- DBSP is implemented in Rust and uses Rust's ` cargo ` build system. The SQL
152+ Feldera is implemented in Rust and uses Rust's ` cargo ` build system. The SQL
151153to DBSP compiler is implemented in Java and uses ` maven ` as its build system.
152154
153155You can build the rust sources by runnning the following at the top level of this tree.
@@ -162,13 +164,14 @@ To build the SQL to DBSP compiler, run the following from `sql-to-dbsp-compiler/
162164mvn package
163165```
164166
165- If you want to develop DBSP without installing the required toolchains
167+ If you want to develop Feldera without installing the required toolchains
166168locally, you can use Github Codespaces; from
167169https://github.com/feldera/feldera , click on the green ` <> Code ` button,
168170then select Codespaces and click on "Create codespace on main".
169171
170172## Learning the DBSP Rust code
171173
174+ DBSP is a key crate that powers Feldera's pipelines.
172175To learn how the DBSP core works, we recommend starting with the tutorial.
173176
174177From the project root:
0 commit comments