LogoLogo
Back to Speedb.io⭐ GitHubDiscord
  • 👋About
    • Speedb Use Cases
    • Speedb Communication Channels
    • Release Cadence
    • Releases
    • Roadmap
  • 💻Getting started
    • Speedb Quick Start Example
    • Dependencies
    • How to Compile Speedb
    • Drop-in Replacement
    • Use prebuilt binaries
    • How to contribute
      • Contribute code
      • Feature request process
      • Submit a pull request
      • Add or update documentation
      • Report bugs and other issues
      • Help with new and ongoing feature development
    • Kafka Streams: How to use Speedb instead of RocksDB?
  • ✨Speedb Features
    • Memory Tracking
    • Speedb Tuning Function
    • Table Pinning Policy
    • Snapshot Optimization
    • On Thread Start Callback
    • Write Flow
    • Global Delayed write
    • Live Configuration Changes
    • Report Index Size per Column Family
    • Proactive Flushing
    • Sorted Hash Memtable
    • Paired Bloom Filter
  • ➕Enhancements
    • Range Delete Improvement
    • Dynamic Delayed Writes
    • Reduce switch memtable latency
  • 🛠️Tools
    • Log Parser
    • DB_bench: Groups
    • Beezcli Tool
  • 🔦RocksDB Basics
  • 📈Performance testing
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Getting started
  2. How to contribute

Submit a pull request

This page describes the process for submitting a pull request for a code change.

PreviousFeature request processNextAdd or update documentation

Last updated 2 years ago

Was this helpful?

When you're finished with your code changes, create a pull request, also known as a PR. If you're unfamiliar with open-source contributions on GitHub, follow the .

Important information when creating a pull request

  • Describe what your change achieves, especially if there isn't a relevant issue open.

  • Reference relevant issues and discussions, and don't forget to if you're solving one.

  • Explain how you tested your changes (we recommend adding a "Test Plan:" section to the pull request summary, which specifies what testing was done to validate the quality and performance of the change).

  • If your change impacts performance, explain why the specific performance environment was chosen. Also specify at least one benchmark test case that favors the improvement and share the results.

  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Speedb team member will review your proposal. We may ask questions or request additional information.

  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.

  • If you run into any merge issues, check out this to help you resolve merge conflicts and other issues.

You can submit a .

💻
Creating a pull request guide
link your PR to an issue
git tutorial
pull request here