Contribute a GitHub Pull Request in Six Steps

A good pull request does more than push code to a remote repository. It keeps the scope focused, explains the motivation, passes tests, and follows the project's contribution rules.

1. Fork the repository

Open the repository on GitHub and click Fork to create a copy under your account.

2. Clone your fork

git clone git@github.com:{username}/seata.git
cd seata

3. Configure identity and upstream

git config user.name "{username}"
git config user.email "{email}"
git remote add upstream git@github.com:seata/seata.git
git remote set-url --push upstream no-pushing

The last command helps prevent accidental pushes to the upstream project.

4. Create a feature branch

Fetch the latest upstream branch and create a focused topic branch:

git fetch upstream
git checkout -b {branch-name} upstream/develop
git push -u origin {branch-name}

Make the change, run the required tests, and commit with a clear message:

git add .
git commit -m "fix: describe the change"
git push

5. Open the pull request

On GitHub, open a pull request from your forked branch to the target upstream branch. Follow the repository template and explain:

• what problem the change solves;
• how it works;
• how it was tested;
• any compatibility or migration impact.

6. Address review feedback

Continue committing to the same branch and push again. The pull request updates automatically. After the change is merged, delete the branch locally and remotely when it is no longer needed.