seg_yinzy
/
DolphinScheduler
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Modify contribution document (#7552)

dailidong-patch-1
J·Y 2021-12-23 09:28:19 +08:00 committed by GitHub
parent 82075a4476
commit 4c918f6167
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
CONTRIBUTING.md
View File

@ -1,11 +1,11 @@
# How To Contribute
# Development
Start by forking the dolphinscheduler GitHub repository, make changes in a branch and then send a pull request. Start by forking the dolphinscheduler GitHub repository, make changes in a branch and then send a pull request.
## Set up your dolphinscheduler GitHub Repository ## Set up your dolphinscheduler GitHub Repository
There are three branches in the remote repository currently: There are three branches in the remote repository currently:
- `master` : normal delivery branch. After the stable version is released, the code for the stable version branch is merged into the master branch. - `master` : normal delivery branch. After the stable version is released, the code for the stable version branch is merged into the master branch.
- `dev` : daily development branch. The daily development branch, the newly submitted code can pull requests to this branch. - `dev` : daily development branch. The daily development branch, the newly submitted code can pull requests to this branch.
@ -17,12 +17,12 @@ So, you should fork the `dev` branch.
After forking the [dolphinscheduler upstream source repository](https://github.com/apache/dolphinscheduler/fork) to your personal repository, you can set your personal development environment. After forking the [dolphinscheduler upstream source repository](https://github.com/apache/dolphinscheduler/fork) to your personal repository, you can set your personal development environment.
```sh ```sh
$ cd <your work direcotry> cd <your work direcotry>
$ git clone < your personal forked dolphinscheduler repo> git clone <your personal forked dolphinscheduler repo>
$ cd dolphinscheduler cd dolphinscheduler
``` ```
## Set git remote as ``upstream`` ## Set git remote as `upstream`
Add remote repository address, named upstream Add remote repository address, named upstream
@ -52,35 +52,35 @@ git checkout origin/dev
git merge --no-ff upstream/dev git merge --no-ff upstream/dev
``` ```
If remote branch has a new branch `DEV-1.0`, you need to synchronize this branch to the local repository. If remote branch has a new branch `dev-1.0`, you need to synchronize this branch to the local repository, then push to your own repository.
``` ```sh
git checkout -b dev-1.0 upstream/dev-1.0 git checkout -b dev-1.0 upstream/dev-1.0
git push --set-upstream origin dev-1.0 git push --set-upstream origin dev-1.0
``` ```
## Create your feature branch ## Create your feature branch
Before making code changes, make sure you create a separate branch for them. Before making code changes, make sure you create a separate branch for them.
```sh ```sh
$ git checkout -b <your-feature> git checkout -b <your-feature-branch> dev
``` ```
## Commit changes ## Commit changes
After modifying the code locally, submit it to your own repository: After modifying the code locally, submit it to your own repository:
```sh ```sh
git commit -m 'information about your feature' git commit -m 'information about your feature'
``` ```
## Push to the branch ## Push to the branch
Push your locally committed changes to the remote origin (your fork). Push your locally committed changes to the remote origin (your fork).
``` ```sh
$ git push origin <your-feature> git push origin <your-feature-branch>
``` ```
## Create a pull request ## Create a pull request
@ -99,14 +99,3 @@ Select the modified local branch and the branch to merge past to create a pull r
</p> </p>
Next, the administrator is responsible for **merging** to complete the pull request. Next, the administrator is responsible for **merging** to complete the pull request.