From 5c168315104794597d201c253571d4ce4a986cea Mon Sep 17 00:00:00 2001 From: zhangjian <1361320460@qq.com> Date: Fri, 30 Jun 2023 16:38:10 +0800 Subject: [PATCH 1/4] modify ASF and remove meaningless CLA --- .asf.yaml | 3 ++- CONTRIBUTING.md | 8 ++------ 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/.asf.yaml b/.asf.yaml index f83048d7b3..1eaf7bddf2 100644 --- a/.asf.yaml +++ b/.asf.yaml @@ -57,4 +57,5 @@ notifications: issues: issues@hugegraph.apache.org issues_status: dev@hugegraph.apache.org issues_comment: issues@hugegraph.apache.org - discussions: dev@hugegraph.apache.org + discussions_status: dev@hugegraph.apache.org + discussions_comment: issues@hugegraph.apache.org diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ed63e97c8..17c1d1cd1c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,8 @@ The following is a contribution guide for HugeGraph: ## 1. Preparation +**Recommended**: You can use [GitHub desktop](https://desktop.github.com/) to greatly simplify the PR process. + We can contribute by reporting issues, submitting code patches or any other feedback. Before submitting the code, we need to do some preparation: @@ -37,8 +39,6 @@ Before submitting the code, we need to do some preparation: git config user.email "{email-address-of-github}" # like "jermy@apache.org" ``` -**Recommended**: You can use [GitHub desktop](https://desktop.github.com/) to greatly simplify the PR 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/incubator-hugegraph/issues/new). @@ -109,10 +109,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: image From c7a869adf3adc9bcfc826cacb6278e9245822e11 Mon Sep 17 00:00:00 2001 From: zhangjian <1361320460@qq.com> Date: Fri, 30 Jun 2023 18:38:18 +0800 Subject: [PATCH 2/4] Modify the difference between doc and server --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 17c1d1cd1c..4df6dabf38 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,6 +71,20 @@ 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.2.1 Check licenses +If we want to add new third-party dependencies to the `HugeGraph` project, we need to do the following things: +1. Find the third-party dependent repository, put the dependent `license` file into [./hugegraph-dist/release-docs/licenses/](https://github.com/apache/incubator-hugegraph/tree/master/hugegraph-dist/release-docs/licenses) path. +2. Declare the dependency in [./hugegraph-dist/release-docs/LICENSE](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/release-docs/LICENSE) `LICENSE` information. +3. Find the NOTICE file in the repository and append it to [./hugegraph-dist/release-docs/NOTICE](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/release-docs/NOTICE) file (skip this step if there is no NOTICE file). +4. Execute locally [./hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh) to update the dependency list [known-dependencies.txt](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/scripts/dependency/known-dependencies.txt) (or manually update) . + +**Example**: A new third-party dependency is introduced into the project -> `ant-1.9.1.jar` +- The project source code is located at: https://github.com/apache/ant/tree/rel/1.9.1 +- LICENSE file: https://github.com/apache/ant/blob/rel/1.9.1/LICENSE +- NOTICE file: https://github.com/apache/ant/blob/rel/1.9.1/NOTICE + +The license information of `ant-1.9.1.jar` needs to be specified in the LICENSE file, and the notice information needs to be specified in the NOTICE file. The detailed LICENSE file corresponding to ant-1.9.1.jar needs to be copied to our licenses/ directory. Finally update the known-dependencies.txt file. + #### 3.3 Commit changes to git repo After the code has been completed, we submit them to the local git repo: From d2aeed06211a97c7c75d1afab8170b4b70a0fd9c Mon Sep 17 00:00:00 2001 From: zhangjian <1361320460@qq.com> Date: Sat, 1 Jul 2023 13:09:20 +0800 Subject: [PATCH 3/4] Modify the difference between doc and server --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4df6dabf38..e064df2475 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,6 @@ The following is a contribution guide for HugeGraph: ## 1. Preparation -**Recommended**: You can use [GitHub desktop](https://desktop.github.com/) to greatly simplify the PR process. We can contribute by reporting issues, submitting code patches or any other feedback. From 5a4f1d1bff5d2385c122d45f77716e6080b01a14 Mon Sep 17 00:00:00 2001 From: zhangjian <1361320460@qq.com> Date: Sat, 1 Jul 2023 13:10:01 +0800 Subject: [PATCH 4/4] Modify the difference between doc and server --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e064df2475..4df6dabf38 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,7 @@ The following is a contribution guide for HugeGraph: ## 1. Preparation +**Recommended**: You can use [GitHub desktop](https://desktop.github.com/) to greatly simplify the PR process. We can contribute by reporting issues, submitting code patches or any other feedback.