OceanBase Database is a community-driven open source project and we welcome all the contributors. Contributions to the OceanBase Database project are expected to adhere to our Code of Conduct.
Before you contribute, please click the Sign in with Github to agree button to sign the CLA. You can find an example here.
What is CLA?
Please follow these steps to create your Pull Request to this repository.
Note:
This section takes creating a PR to the
master
branch as an example. The steps of creating PRs for other branches are similar.
- Visit the project (https://github.com/oceanbase/oceanbase)
- Click the Fork button to establish an online fork.
# Define your working directory
working_dir=$HOME/Workspace
# Configure GitHub
user={your Github profile name}
# Create your clone
mkdir -p $working_dir
cd $working_dir
git clone [email protected]:<your group>/oceanbase.git
# Add upstream
git remote add upstream [email protected]:<your group>/oceanbase.git
# Set no push for the upstream master
git remote set-url --push upstream no_push
# Confirm your remote setting
git remote -v
-
Get your local master up-to-date with the upstream/master.
cd $working_dir/docs git fetch upstream git checkout master git rebase upstream/master
-
Create a new branch based on the master branch.
git checkout -b new-branch-name
Edit some file(s) on the new-branch-name
branch and save your changes.
git status # Checks the local status
git add <file> ... # Adds the file(s) you want to commit. If you want to commit all changes, you can directly use `git add.`
git commit -m "commit-message: update the xx"
# While on your new branch
git fetch upstream
git rebase upstream/master
git push -u origin new-branch-name # "-u" is used to track the remote branch from the origin
- Visit your fork at https://github.com/$user/docs (replace
$user
with your GitHub account). - Click the
Compare & pull request
button next to yournew-branch-name
branch to create your PR.