Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.5 KB

Contributing to delta-sharing-rs

Development on this project is driven by volunteer contributors. We welcome new contributors and contributions of any kind. Please take note of our code of conduct.

If you want to start contributing, take a look at the issues: https://github.com/delta-incubator/delta-sharing-rs/issues (implementation of good first issue is coming soon).

Claiming an issue

If you want to claim an issue to work on, you can write the word take as a comment in it and you will be automatically assigned.

Quick start

Full instructions are currently in readme

To make a pull request (PR)

  • Install Rust, e.g. as described here
  • Make sure all the following steps run/pass locally before submitting a PR (requires clippy)
cargo fmt -- --check
cargo clippy --tests
cargo doc --no-deps

Developing in VSCode

These are just some basic steps/components to get you started, there are many other very useful extensions for VSCode

  • For a better Rust development experience, install rust extention
  • For debugging Rust code, install CodeLLDB. The extension should even create Debug launch configurations for the project if you allow it, an easy way to get started. Just set a breakpoint and run the relevant configuration.