KWDB

https://gitee.com/kwdb/docs
Admin
KWDB Docs provides comprehensive documentation for KWDB, covering product overview, administration,...
Tokens:1,714
Snippets:18
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### Clone KWDB Docs Repository (Bash)

Source: https://gitee.com/kwdb/docs/blob/master/CONTRIBUTING_EN.md

Clones the KWDB documentation repository from Gitee to your local machine. Replace '$user' with your Gitee ID and '$working_dir' with your desired local directory.

```bash
cd $working_dir # Switch to the directory that you want put the fork in, for example, "cd ~/Documents/Gitee".
git clone https://gitee.com/$user/kwdb/docs.git # Replace "$user" with your Gitee ID.
```

--------------------------------

### Commit Changes (Bash)

Source: https://gitee.com/kwdb/docs/blob/master/CONTRIBUTING_EN.md

Stages and commits your changes to the local repository. Use 'git status' to check modifications, 'git add' to stage files (or 'git add .' for all), and 'git commit' with a descriptive message.

```bash
git status # Check your updated docs. 
git add <file> ... # Adds the file(s) you want to commit. If you want to commit all changes, you can directly use `git add .` or `git add -A`.
git commit -m "commit-message: update the xx"
```

--------------------------------

### Create New Branch (Bash)

Source: https://gitee.com/kwdb/docs/blob/master/CONTRIBUTING_EN.md

Creates a new branch based on the current master branch, allowing you to work on new features or fixes independently. Replace 'new-branch-name' with a descriptive name for your branch.

```bash
git checkout -b new-branch-name
```

--------------------------------

### Push Changes to Remote (Bash)

Source: https://gitee.com/kwdb/docs/blob/master/CONTRIBUTING_EN.md

Pushes your committed changes from your local branch to the remote repository on Gitee. The '-u' flag sets the upstream for future pushes.

```bash
git push origin new-branch-name # You can also use the "git push -u origin new-branch-name".
```

--------------------------------

### Sync Branch with Remote Master (Bash)

Source: https://gitee.com/kwdb/docs/blob/master/CONTRIBUTING_EN.md

Keeps your feature branch synchronized with the latest changes from the remote master branch. This helps in resolving potential merge conflicts early.

```bash
# on "new-branch-name" branch
git fetch origin
git rebase origin/master
```

--------------------------------

### Update Local Master Branch (Bash)

Source: https://gitee.com/kwdb/docs/blob/master/CONTRIBUTING_EN.md

Ensures your local master branch is up-to-date with the remote master branch before creating a new feature branch. This involves fetching changes and rebasing.

```bash
cd $working_dir/docs
git fetch origin
git checkout master
git rebase origin/master
```
Tokens:
Raw