Skip to content

Pull Requests Submission Guide

Guangli Dai edited this page Aug 21, 2025 · 1 revision

Clear PRs make it easier for maintainers and contributors to quickly understand the purpose and impact of your changes. Use the following labels to improve clarity and consistency in your submissions.

PR Labels Overview

Each PR can be assigned one or more labels to indicate the type(s) of change included. Using appropriate labels helps reviewers understand your PR’s intent at a glance and enables faster review cycles. Labels are not exclusive—feel free to use all that apply!

Label Purpose
Bug Fix Resolves a specific bug, error, or unintended behavior in the codebase.
Optimization Improves jemalloc’s efficiency in CPU, memory usage, and observability, or enhances trade-offs between them.
Cleanup Improves code quality, readability, maintainability, or documentation.

PR Description Templates

When submitting a PR, use the template that matches your PR’s primary label. Copy the template into your PR description and fill in the details.

Bug Fix PR

**Issue Reference**
Description or a link to the description of the bug.
**Root Cause**
Explain what caused the bug.
**Fix Details**
Describe the changes made to resolve the issue.
**Testing**
Describe how you tested the fix (e.g., new/updated tests, manual verification).

Optimization PR

**Background**
Explain the previous behavior or limitation.
**Optimization Details**
Describe the changes made and how they improve efficiency, resource usage, or trade-offs. 
**Impact**
Summarize the expected impact (e.g., performance gains, reduced memory usage, new or changed configuration options, and any changes in default behavior). Data in production or benchmark is required. 

Cleanup PR

**Motivation**
Explain why this cleanup was needed (e.g., code readability, maintainability, removing dead code).
**Changes**
Summarize the main changes (e.g., codes moved around and logics after refactoring).
**Testing**
Describe any testing done to ensure no functional changes were introduced.

Clone this wiki locally