Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: sync cn and en contribution doc with server CONTRIBUTION.md #279

Merged
merged 2 commits into from
Sep 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions content/cn/docs/contribution-guidelines/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ The following is a contribution guide for HugeGraph:

## 1. Preparation

**建议**: 使用 [GitHub desktop](https://desktop.github.com/) 可以大幅简化和改善你提交 PR/Commit 的过程, 特别适合新人

We can contribute by reporting issues, submitting code patches or any other feedback.

Before submitting the code, we need to do some preparation:
Expand Down Expand Up @@ -41,9 +43,7 @@ Before submitting the code, we need to do some preparation:
git config user.name "{full-name}" # like "Jermy Li"
git config user.email "{email-address-of-github}" # like "[email protected]"
```

Optional: You can use [GitHub desktop](https://desktop.github.com/) to greatly simplify the commit and update process.


## 2. Create an Issue on GitHub

If you encounter bugs or have any questions, please go to [GitHub Issues](https://github.com/apache/incubator-hugegraph/issues) to report them and feel free to [create an issue](https://github.com/apache/hugegraph/issues/new).
Expand Down Expand Up @@ -129,10 +129,6 @@ Note that since GitHub requires submitting code through `username + token` (inst

Go to the web page of GitHub fork repo, there would be a chance to create a Pull Request after pushing to a new branch, just click button "Compare & pull request" to do it. Then edit the description for proposed changes, which can just be copied from the commit message.

Please sign the HugeGraph CLA when contributing code for the first time. You can sign the CLA by just posting a Pull Request Comment same as the below format:

`I have read the CLA Document and I hereby sign the CLA`

Note: please make sure the email address you used to submit the code is bound to the GitHub account. For how to bind the email address, please refer to https://github.com/settings/emails:
<img width="1280" alt="image" src="https://user-images.githubusercontent.com/9625821/163522445-2a50a72a-dea2-434f-9868-3a0d40d0d037.png">

Expand Down
8 changes: 2 additions & 6 deletions content/en/docs/contribution-guidelines/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ The following is a contribution guide for HugeGraph:

## 1. Preparation

Optional: You can use [GitHub desktop](https://desktop.github.com/) to greatly simplify the commit and update process.

We can contribute by reporting issues, submitting code patches or any other feedback.

Before submitting the code, we need to do some preparation:
Expand Down Expand Up @@ -40,8 +42,6 @@ Before submitting the code, we need to do some preparation:
git config user.email "{email-address-of-github}" # like "[email protected]"
```

Optional: You can use [GitHub desktop](https://desktop.github.com/) to greatly simplify the commit and update process.

## 2. Create an Issue on GitHub

If you encounter bugs or have any questions, please go to [GitHub Issues](https://github.com/apache/incubator-hugegraph/issues) to report them and feel free to [create an issue](https://github.com/apache/hugegraph/issues/new).
Expand Down Expand Up @@ -126,10 +126,6 @@ Note that since GitHub requires submitting code through `username + token` (inst

Go to the web page of GitHub fork repo, there would be a chance to create a Pull Request after pushing to a new branch, just click button "Compare & pull request" to do it. Then edit the description for proposed changes, which can just be copied from the commit message.

Please sign the HugeGraph CLA when contributing code for the first time. You can sign the CLA by just posting a Pull Request Comment same as the below format:

`I have read the CLA Document and I hereby sign the CLA`

Note: please make sure the email address you used to submit the code is bound to the GitHub account. For how to bind the email address, please refer to https://github.com/settings/emails:
<img width="1280" alt="image" src="https://user-images.githubusercontent.com/9625821/163522445-2a50a72a-dea2-434f-9868-3a0d40d0d037.png">

Expand Down