Skip to content

Latest commit

 

History

History
48 lines (39 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

48 lines (39 loc) · 3.51 KB
Raw

Contributing to rust-rocksdb

Thank you for taking an interest in the project, and contributing to it - it's appreciated! There are several ways you can contribute:

Please note all contributors must adhere to the code of conduct.

Bug Reports

  • Ensure the bug has not already been reported - this can be done with a quick search of the existing open issues.
  • Ensure the bug applies to the Rust wrapper, and not the underlying library - bugs in the RocksDB library should be reported upstream.
  • When creating an issue please try to:
    • Use a clear and descriptive title to identify the issue
    • Provide enough context to acurately summarize the issue. Not every issue will need detailed steps to recreate, example code, stack traces, etc. - use your own judgment on what information would be helpful to anyone working on the issue. It's easier for someone to skim over too much context, than stop and wait for a response when context is missing.

Feature Requests

Feature requests will primarily come in the form of ergonomics involving the Rust language, or in bringing the wrapper into parity with the library's API. Please create an issue with any relevant information.

Documentation

Much of the documentation should mirror or reference the library's documentation. If the wrapper or its exposed functions are missing documentation or contain inaccurate information please submit a pull request.

Discussion

Discussion around design and development of the wrapper primarily occurs within issues and pull requests. Don't be afraid to participate if you have questions, concerns, insight, or advice.

Pull Requests

Pull requests are welcome, and when contributing code, the author agrees to do so under the project's licensing - Apache 2.0 as of the time of this writing. The maintainers greatly appreciate PRs that follow open-source contribution best practices:

  1. Fork this repository to your personal GitHub account.
  2. Create a branch that includes your changes, keep changes isolated and granular.
  3. Include any relevant documentation and/or tests. Write documentation tests when relevant.
  4. Apply cargo fmt to ensure consistent formatting.
  5. Create a pull request against this repository.

For pull requests that would benefit from discussion and review earlier in the development process, use a Draft Pull Request.

Additional Resources

Some useful information for working with RocksDB in Rust: