docs/contributors-guide.md

---
title: Contributors Guide
---

<!---
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at
    http://www.apache.org/licenses/LICENSE-2.0
  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
-->

We want to make contributing to SpatialBench as easy and transparent as
possible. If you have suggestions to improve this contribution guide, feel
free to [open an issue in GitHub](https://github.com/apache/sedona-spatialbench/issues).

## Our Development Process

To contribute, please find an existing issue or open a new one. Claiming the issue you are working on helps us better track progress.

## Pull Requests

We actively welcome your pull requests.

1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the related documentation.
4. Ensure the standard tests and conformance tests are passing.
5. Ensure your code follows Rust best practices and addresses all lints from clippy.
6. Open your pull request and wait for a review and approval.

## Filing Issues

When opening a new issue, please follow the issue template and provide as many details
as possible, including a reproducible example if applicable.

## Coding Style

Follow standard Rust formatting guidelines. For idiomatic code
style, consult [Effective Rust](https://www.lurklurk.org/effective-rust/title-page.html).

## License

By contributing to SpatialBench, you agree that your contributions will be licensed
under the `LICENSE` file in the root directory of this source tree.