Paddle Repository PR Creation and Update

Process

1. Check Branch Status

• Check if the current branch has been pushed to the remote; if not, execute

  git push -u origin HEAD

  .
• If the current branch name is

  main

  or

  master

  , confirm with the user whether they really want to submit a PR directly on this branch before proceeding.

2. Organize Changes by Logical Theme

• Do not mechanically list each commit.
• Group changes by "Function / Purpose" and answer:
  • Why is this change needed?
  • What problem does it solve?
  • Which modules are roughly modified?

3. Use Paddle Official PR Template

• PR content must follow the Paddle official PR template:
  • Template link:

    https://github.com/PaddlePaddle/Paddle/blob/develop/.github/PULL_REQUEST_TEMPLATE.md

  • The template uses level 3 headings (

    ###

    ) as the title of each section, and you need to keep consistency when generating the PR description.
  • Simplified template structure:

### PR Category
<!-- One of [ User Experience | Execute Infrastructure | Operator Mechanism | CINN | Custom Device | Performance Optimization | Distributed Strategy | Parameter Server | Communication Library | Auto Parallel | Inference | Environment Adaptation ] -->

### PR Types
<!-- One of [ New features | Bug fixes | Improvements | Performance | BC Breaking | Deprecations | Docs | Devs | Not User Facing | Security | Others ] -->

### Description

### 是否引起精度变化
<!-- one of the following [ 是 | 否 ]-->

• When generating the PR description, fill in the following four sections in order:
  • PR Category: High-level category, such as Bug fix, Feature, Refactor, Doc, etc.
  • PR Types: More detailed type description, such as API change, performance optimization, new operator addition, etc.
  • Description: Briefly explain the background, motivation, and main changes of the PR in natural language. Do not use level 3 or higher headings (

    ###

    ,

    ##

    ,

    #

    ) in the description body. If subheadings are needed for segmentation, use at most level 4 headings (

    ####

    ).
  • Does it cause accuracy changes?: Clearly state whether it will affect the accuracy of existing models or tasks, and provide necessary explanations.

4. Use gh Command to Create / Update PR

• Use the

  gh

  command to create or update a PR.

Title Specification

• The title should be in English overall, concise and clear.
• Recommended format:

  [PR Category] Brief Description

  • Example:

    [CINN] avoid wrong fusion for xxx op

  • Example:

    [LargeTensor] fix xxx kernel

  • Example:

    [CodeStyle] update code style

• Avoid vague titles, such as:

  • fix bug

    /

    update code

    /

    test

    /

    temp

    /

    WIP

    etc.
• Try to clarify "what was done" or "the purpose of the modification" in one line, without listing all details.

gh pr create --title "[xxx] xxx" --body "$(cat <<'EOF'
### PR Category
Operator Mechanism

### PR Types
New features

### Description
在这里说明该改动的动机和主要变化，可根据实际情况扩展。

### 是否引起精度变化
否

EOF
)"

Notes

• Always use the section structure of the Paddle official PR template, keep the title hierarchy consistent with the template (the template uses level 3 headings

  ###

  ), and do not customize new top-level headings.
• Do not use level 3 or higher headings in the Description body. If segmentation is needed, use at most level 4 headings (

  ####

  ).
• Prioritize emphasizing "why this change is needed" rather than listing all implementation details.
• If business or background information is unclear, ask the user for clarification first before generating the PR description.
• After successfully creating or updating the PR, return the PR URL for the user to view.