You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+16-6Lines changed: 16 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,8 @@ The following is a contribution guide for HugeGraph:
9
9
10
10
## 1. Preparation
11
11
12
+
**Recommended**: You can use [GitHub desktop](https://desktop.github.com/) to greatly simplify the PR process.
13
+
12
14
We can contribute by reporting issues, submitting code patches or any other feedback.
13
15
14
16
Before submitting the code, we need to do some preparation:
@@ -37,8 +39,6 @@ Before submitting the code, we need to do some preparation:
37
39
git config user.email "{email-address-of-github}"# like "jermy@apache.org"
38
40
```
39
41
40
-
**Recommended**: You can use [GitHub desktop](https://desktop.github.com/) to greatly simplify the PR process.
41
-
42
42
## 2. Create an Issue on GitHub
43
43
44
44
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).
@@ -71,6 +71,20 @@ mvn test -Pcore-test,memory
71
71
```
72
72
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).
73
73
74
+
##### 3.2.1 Check licenses
75
+
If we want to add new third-party dependencies to the `HugeGraph` project, we need to do the following things:
76
+
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.
77
+
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.
78
+
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).
79
+
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) .
80
+
81
+
**Example**: A new third-party dependency is introduced into the project -> `ant-1.9.1.jar`
82
+
- The project source code is located at: https://github.com/apache/ant/tree/rel/1.9.1
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.
87
+
74
88
#### 3.3 Commit changes to git repo
75
89
76
90
After the code has been completed, we submit them to the local git repo:
@@ -109,10 +123,6 @@ Note that since GitHub requires submitting code through `username + token` (inst
109
123
110
124
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.
111
125
112
-
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:
113
-
114
-
`I have read the CLA Document and I hereby sign the CLA`
115
-
116
126
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:
0 commit comments