This is an automated email from the ASF dual-hosted git repository.
jin pushed a commit to branch website
in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-doc.git
The following commit(s) were added to refs/heads/website by this push:
new 34c06cb fix: contribution guide page 404 (#119)
34c06cb is described below
commit 34c06cb8fe77e542c38015f9b74104acd4600fc3
Author: Simon Cheung <[email protected]>
AuthorDate: Thu Apr 28 21:26:41 2022 +0800
fix: contribution guide page 404 (#119)
---
content/en/docs/changelog/_index.md | 2 +-
content/en/docs/contribution-guidelines/_index.md | 5 +
.../en/docs/contribution-guidelines/contribute.md | 167 +++++++++++++++++++++
.../en/docs/contribution-guidelines/subscribe.md | 27 ++++
4 files changed, 200 insertions(+), 1 deletion(-)
diff --git a/content/en/docs/changelog/_index.md
b/content/en/docs/changelog/_index.md
index e00adbf..41b3951 100644
--- a/content/en/docs/changelog/_index.md
+++ b/content/en/docs/changelog/_index.md
@@ -1,5 +1,5 @@
---
title: "CHANGELOGS"
linkTitle: "CHANGELOGS"
-weight: 9
+weight: 10
---
\ No newline at end of file
diff --git a/content/en/docs/contribution-guidelines/_index.md
b/content/en/docs/contribution-guidelines/_index.md
new file mode 100755
index 0000000..ea28e2d
--- /dev/null
+++ b/content/en/docs/contribution-guidelines/_index.md
@@ -0,0 +1,5 @@
+---
+title: "Contribution Guidelines"
+linkTitle: "Contribution Guidelines"
+weight: 9
+---
\ No newline at end of file
diff --git a/content/en/docs/contribution-guidelines/contribute.md
b/content/en/docs/contribution-guidelines/contribute.md
new file mode 100644
index 0000000..2ce9324
--- /dev/null
+++ b/content/en/docs/contribution-guidelines/contribute.md
@@ -0,0 +1,167 @@
+---
+title: "How to Contribute to HugeGraph"
+linkTitle: "How to Contribute to HugeGraph"
+weight: 1
+---
+
+Thanks for taking the time to contribute! As an open source project, HugeGraph
is looking forward to be contributed from everyone, and we are also grateful to
all of the contributors.
+
+The following is a contribution guide for HugeGraph:
+
+<img width="884" alt="image"
src="https://user-images.githubusercontent.com/9625821/159643158-8bf72c0a-93c3-4a58-8912-7b2ab20ced1d.png";>
+
+## 1. Preparation
+
+We can contribute by reporting issues, submitting code patches or any other
feedback.
+
+Before submitting the code, we need to do some preparation:
+
+1. Sign up or login to GitHub: [https://github.com](https://github.com)
+
+2. Fork HugeGraph repo from GitHub:
[https://github.com/apache/incubator-hugegraph/fork](https://github.com/hugegraph/hugegraph/fork)
+
+3. Clone code from fork repo to local:
[https://github.com/${GITHUB_USER_NAME}/hugegraph](https://github.com/${GITHUB_USER_NAME}/hugegraph)
+
+ ```shell
+ # clone code from remote to local repo
+ git clone https://github.com/${GITHUB_USER_NAME}/hugegraph
+ ```
+
+4. Configure local HugeGraph repo
+
+ ```shell
+ cd hugegraph
+
+ # add upstream to synchronize the latest code
+ git remote add hugegraph https://github.com/hugegraph/hugegraph
+
+ # set name and email to push code to github
+ 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/hugegraph/hugegraph/issues/new).
+
+## 3. Make changes of code locally
+
+#### 3.1 Create a new branch
+
+Please don't use master branch for development. Instead we should create a new
branch:
+
+```shell
+# checkout master branch
+git checkout master
+# pull the latest code from official hugegraph
+git pull hugegraph
+# create new branch: bugfix-branch
+git checkout -b bugfix-branch
+```
+
+#### 3.2 Change the code
+
+Assume that we need to modify some files like "HugeGraph.java" and
"HugeFactory.java":
+
+```shell
+# modify code to fix a bug
+vim hugegraph-core/src/main/java/com/baidu/hugegraph/HugeGraph.java
+vim hugegraph-core/src/main/java/com/baidu/hugegraph/HugeFactory.java
+# run test locally (optional)
+mvn test -Pcore-test,memory
+```
+Note: In order to be consistent with the code style easily, if you use
[IDEA](https://www.jetbrains.com/idea/) as your IDE, you can directly
[import](https://www.jetbrains.com/help/idea/configuring-code-style.html) our
code style [configuration file](./hugegraph-style.xml).
+
+#### 3.3 Commit changes to git repo
+
+After the code has been completed, we submit them to the local git repo:
+
+```shell
+# add files to local git index
+git add hugegraph-core/src/main/java/com/baidu/hugegraph/HugeGraph.java
+git add hugegraph-core/src/main/java/com/baidu/hugegraph/HugeFactory.java
+# commit to local git repo
+git commit
+```
+
+Please edit the commit message after running `git commit`, we can explain what
and how to fix a bug or implement a feature, the following is an example:
+
+```sh
+Fix bug: run deploy multiple times
+
+fix #ISSUE_ID
+```
+
+> Please remember to fill in the issue id, which was generated by GitHub
after issue creation.
+
+#### 3.4 Push commit to GitHub fork repo
+
+Push the local commit to GitHub fork repo:
+
+```shell
+# push the local commit to fork repo
+git push origin bugfix-branch:bugfix-branch
+```
+
+Note that since GitHub requires submitting code through `username + token`
(instead of using `username + password` directly), you need to create a GitHub
token from https://github.com/settings/tokens:
+<img width="1280" alt="image"
src="https://user-images.githubusercontent.com/9625821/163524204-7fe0e6bf-9c8b-4b1a-ac65-6a0ac423eb16.png";>
+
+## 4. Create a Pull Request
+
+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";>
+
+## 5. Code review
+
+ Maintainers will start the code review after all the **automatic** checks are
passed:
+
+- Check: Contributor License Agreement is signed
+- Check: Travis CI builds is passed (automatically Test and Deploy)
+
+The commit will be accepted and merged if there is no problem after review.
+
+Please click on "Details" to find the problem if any check does not pass.
+
+If there are checks not passed or changes requested, then continue to modify
the code and push again.
+
+## 6. Further changes after review
+
+If we have not passed the review, don't be discouraged. Usually a commit needs
to be reviewed several times before being accepted! Please follow the review
comments and make further changes.
+
+After the further changes, we submit them to the local repo:
+
+```shell
+# commit all updated files in a new commit,
+# please feel free to enter any appropriate commit message, note that
+# we will squash all commits in the pull request as one commit when
+# merging into the master branch.
+git commit -a
+```
+
+> If there are conflicts that prevent the code from being merged, we need to
rebase on master branch:
+>
+> ```shell
+> # synchronize the latest code
+> git checkout master
+> git pull hugegraph
+> # rebase on master
+> git checkout bugfix-branch
+> git rebase -i master
+> ```
+
+And push it to GitHub fork repo again:
+
+```shell
+# force push the local commit to fork repo
+git push -f origin bugfix-branch:bugfix-branch
+```
+
+GitHub will automatically update the Pull Request after we push it, just wait
for code review.
diff --git a/content/en/docs/contribution-guidelines/subscribe.md
b/content/en/docs/contribution-guidelines/subscribe.md
new file mode 100644
index 0000000..2256f10
--- /dev/null
+++ b/content/en/docs/contribution-guidelines/subscribe.md
@@ -0,0 +1,27 @@
+---
+title: "Subscribe Mailing Lists"
+linkTitle: "Subscribe Mailing Lists"
+weight: 2
+---
+
+It is highly recommended to subscribe to the development mailing list to keep
up-to-date with the community.
+
+In the process of using HugeGraph, if you have any questions or ideas,
suggestions, you can participate in the HugeGraph community building through
the Apache mailing list. Sending a subscription email is also very simple, the
steps are as follows:
+
+1. Send an email to [email protected] with your own email
address, subject and content are arbitrary.
+
+2. Receive confirmation email and reply. After completing step 1, you will
receive a confirmation email from [email protected] (if not
received, please confirm whether the email is automatically classified as spam,
promotion email, subscription email, etc.) . Then reply directly to the email,
or click on the link in the email to reply quickly, the subject and content are
arbitrary.
+
+3. Receive a welcome email. After completing the above steps, you will receive
a welcome email with the subject WELCOME to [email protected], and you
have successfully subscribed to the Apache HugeGraph mailing list.
+
+# Unsubscribe Mailing Lists
+
+If you do not need to know what's going on with HugeGraph, you can unsubscribe
from the mailing list.
+
+Unsubscribe from the mailing list steps are as follows:
+
+1. Send an email to [email protected] with your subscribed
email address, subject and content are arbitrary.
+
+2. Receive confirmation email and reply. After completing step 1, you will
receive a confirmation email from [email protected] (if not
received, please confirm whether the email is automatically classified as spam,
promotion email, subscription email, etc.) . Then reply directly to the email,
or click on the link in the email to reply quickly, the subject and content are
arbitrary.
+
+3. Receive a goodbye email. After completing the above steps, you will receive
a goodbye email with the subject GOODBYE from [email protected], and
you have successfully unsubscribed to the Apache HugeGraph mailing list, and
you will not receive emails from [email protected].
![https://user-images.githubusercontent.com/9625821/159643158-8bf72c0a-93c3-4a58-8912-7b2ab20ced1d.png"](https://user-images.githubusercontent.com/9625821/159643158-8bf72c0a-93c3-4a58-8912-7b2ab20ced1d.png"){kind=link}
![https://user-images.githubusercontent.com/9625821/163524204-7fe0e6bf-9c8b-4b1a-ac65-6a0ac423eb16.png"](https://user-images.githubusercontent.com/9625821/163524204-7fe0e6bf-9c8b-4b1a-ac65-6a0ac423eb16.png"){kind=link}
![https://user-images.githubusercontent.com/9625821/163522445-2a50a72a-dea2-434f-9868-3a0d40d0d037.png"](https://user-images.githubusercontent.com/9625821/163522445-2a50a72a-dea2-434f-9868-3a0d40d0d037.png"){kind=link}