We want to make contributing to this project as easy and transparent as possible, if you have suggestions to improve the contributions guide feel free to open an issue.
We follow a very standard development process, start by picking an existing issue or opening a new one to address a problem you've found. Letting us know which issue you are working on allows us to better track progress.
We actively welcome your pull requests.
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the standard tests and conformance tests are passing.
- Make sure your code follows Rust best practices, address any linting issues clippy might find.
- Run typos locally to catch any spelling mistakes in your changes. For intentional exceptions in rust source files, use
// typos:offand// typos:oncomments. - Open your pull request and wait for a review and approval.
When opening a new issue try and follow the issue template, there are no specific requirements with regards to the overall format but we do like to have as much details as possible and even better reproducible examples.
Prefer following standard Rust guidelines with regards to formatting as for coding style, Effective Rust is a good resource for idiomatic code.
By contributing to tpchgen-rs, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.