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

Feature request process

This page describes the process for a new feature request.

PreviousContribute codeNextSubmit a pull request

Last updated 2 years ago

Was this helpful?

If you have an idea for a new feature, we encourage you to first regarding its viability and potential.

Once you've discussed it with the community, you should prepare a proposal and submit it as a feature request. For your feature proposal, . When working on a proposal, it's important to keep in mind that it takes time to discuss new ideas with the community, review it, and eventually implement it.

We encourage you to discuss your idea early, before even writing your proposal.

Once your proposal is accepted, the next step is to .

A few things to note

  • Bug fixes and mechanical improvements don't need a feature request.

  • All new features and bug fixes must include unit tests, since they help to (a) document and validate concrete usage of a feature and its edge cases, and (b) guard against future breaking changes to lower the maintenance cost.

  • Unit tests must pass with the changes.

  • If a feature with failed tests (unrelated to the feature) is submitted, it will only be considered once the feature passes all testing.

  • Code changes should be made with API compatibility and evolvability in mind.

Pull requests should only be sent once a proposal has been discussed, submitted, and reviewed.

It's important to note that all new features and substantive changes to Speedb need to go through a formal feature request process.

💻
discuss it with the Speedb community
use the feature request template
submit a pull request