Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2.3 KB

README.md

File metadata and controls

46 lines (28 loc) · 2.3 KB

OceanBase seekdb Development Guide

About this guide

  • The target audience of this guide is OceanBase seekdb contributors, both new and experienced.
  • The objective of this guide is to help contributors become an expert of OceanBase seekdb, who is familiar with its design and implementation and thus is able to use it fluently in the real world as well as develop OceanBase seekdb itself deeply.

The structure of this guide

At present, the guide is composed of the following parts:

1. Get Started

This section helps you set up the development environment and get OceanBase seekdb running on your machine. Follow these steps in order if you're new to the project.

  1. Install toolchain - Install the required development tools and dependencies
  2. Get the code, build and run - Clone the repository, build the project, and connect to the seekdb server

2. Development Basics

Once you have the environment set up, these guides will help you develop effectively:

  1. Set up an IDE - Configure your development environment for optimal productivity
  2. Coding Conventions - Learn OceanBase seekdb's programming habits and conventions
  3. Coding Standard - Detailed C++ coding standards and constraints
  4. Write and run unit tests - How to write and execute unit tests
  5. Running MySQL test - How to run MySQL compatibility tests
  6. Debug - Debugging techniques and tools

3. Understanding the Codebase

Before you start developing a big feature, it's recommended to read these documents to better understand OceanBase seekdb's internals:

  1. Logging System - How logging works in OceanBase seekdb
  2. Memory Management - Memory management strategies and best practices
  3. Basic Data Structures - Core data structures used in the codebase

4. Contribute to OceanBase seekdb

Ready to contribute? This guide will help you get involved in the OceanBase community:

  1. Commit code and submit a pull request - Step-by-step guide to contributing code changes

Note: If you're new to the project, we recommend following the sections in order. Experienced contributors can jump directly to the sections they need.