You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hugegraph.apache.org by gi...@apache.org on 2023/06/26 07:00:43 UTC
[incubator-hugegraph-doc] branch asf-site updated: apache: how to add 3rd-party dependency in project (#263)
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-doc.git
The following commit(s) were added to refs/heads/asf-site by this push:
new a11e335b apache: how to add 3rd-party dependency in project (#263)
a11e335b is described below
commit a11e335bd4f77f1b8457a4cf5b1cbedecfb41091
Author: imbajin <im...@users.noreply.github.com>
AuthorDate: Mon Jun 26 07:00:37 2023 +0000
apache: how to add 3rd-party dependency in project (#263)
* Update contribute.md
---------
Co-authored-by: imbajin <ji...@apache.org> d62608a11d20788e4e87f506dcb7a64c479c5303
---
cn/docs/_print/index.html | 2 +-
cn/docs/contribution-guidelines/_print/index.html | 2 +-
cn/docs/contribution-guidelines/contribute/index.html | 8 ++++----
cn/docs/contribution-guidelines/index.xml | 15 +++++++++++++++
cn/docs/index.xml | 15 +++++++++++++++
cn/sitemap.xml | 2 +-
docs/_print/index.html | 2 +-
docs/contribution-guidelines/_print/index.html | 2 +-
docs/contribution-guidelines/contribute/index.html | 8 ++++----
docs/contribution-guidelines/index.xml | 15 +++++++++++++++
docs/index.xml | 15 +++++++++++++++
en/sitemap.xml | 2 +-
sitemap.xml | 2 +-
13 files changed, 75 insertions(+), 15 deletions(-)
diff --git a/cn/docs/_print/index.html b/cn/docs/_print/index.html
index 16e65522..dd3596fc 100644
--- a/cn/docs/_print/index.html
+++ b/cn/docs/_print/index.html
@@ -6487,7 +6487,7 @@ HugeGraph目前采用EdgeCut的分区方案。</p><h3 id=3-vertexid-策略>3. Ve
</span></span><span style=display:flex><span>vim hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># run test locally (optional)</span>
</span></span><span style=display:flex><span>mvn <span style=color:#204a87>test</span> -Pcore-test,memory
-</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href=https://www.jetbrains.com/idea/>IDEA</a> as your IDE, you can directly <a href=https://www.jetbrains.com/help/idea/configuring-code-style.html>import</a> our code style <a href=./hugegraph-style.xml>configuration file</a>.</p><h4 id=33-commit-changes-to-git-repo>3.3 Commit changes to git repo</h4><p>After the code has been completed, we submit them to the local git repo:</p> [...]
+</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href=https://www.jetbrains.com/idea/>IDEA</a> as your IDE, you can directly <a href=https://www.jetbrains.com/help/idea/configuring-code-style.html>import</a> our code style <a href=./hugegraph-style.xml>configuration file</a>.</p><h5 id=321-添加第三方依赖>3.2.1 添加第三方依赖</h5><p>如果我们要在 <code>HugeGraph</code> 项目中添加新的第三方依赖, 我们需要做下面的几件事情：</p><ol><li>找到第三方依赖的仓库，将依赖的 <code>license</code> 文件放到 [...]
</span></span><span style=display:flex><span>git add hugegraph-core/src/main/java/org/apache/hugegraph/HugeGraph.java
</span></span><span style=display:flex><span>git add hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># commit to local git repo</span>
diff --git a/cn/docs/contribution-guidelines/_print/index.html b/cn/docs/contribution-guidelines/_print/index.html
index cf8836b2..f513670c 100644
--- a/cn/docs/contribution-guidelines/_print/index.html
+++ b/cn/docs/contribution-guidelines/_print/index.html
@@ -21,7 +21,7 @@
</span></span><span style=display:flex><span>vim hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># run test locally (optional)</span>
</span></span><span style=display:flex><span>mvn <span style=color:#204a87>test</span> -Pcore-test,memory
-</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href=https://www.jetbrains.com/idea/>IDEA</a> as your IDE, you can directly <a href=https://www.jetbrains.com/help/idea/configuring-code-style.html>import</a> our code style <a href=./hugegraph-style.xml>configuration file</a>.</p><h4 id=33-commit-changes-to-git-repo>3.3 Commit changes to git repo</h4><p>After the code has been completed, we submit them to the local git repo:</p> [...]
+</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href=https://www.jetbrains.com/idea/>IDEA</a> as your IDE, you can directly <a href=https://www.jetbrains.com/help/idea/configuring-code-style.html>import</a> our code style <a href=./hugegraph-style.xml>configuration file</a>.</p><h5 id=321-添加第三方依赖>3.2.1 添加第三方依赖</h5><p>如果我们要在 <code>HugeGraph</code> 项目中添加新的第三方依赖, 我们需要做下面的几件事情：</p><ol><li>找到第三方依赖的仓库，将依赖的 <code>license</code> 文件放到 [...]
</span></span><span style=display:flex><span>git add hugegraph-core/src/main/java/org/apache/hugegraph/HugeGraph.java
</span></span><span style=display:flex><span>git add hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># commit to local git repo</span>
diff --git a/cn/docs/contribution-guidelines/contribute/index.html b/cn/docs/contribution-guidelines/contribute/index.html
index 82ceb4a2..453e3a47 100644
--- a/cn/docs/contribution-guidelines/contribute/index.html
+++ b/cn/docs/contribution-guidelines/contribute/index.html
@@ -5,11 +5,11 @@ Thanks for taking the time to contribute! As an open source project, HugeGraph i
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 the contributors.
The following is a contribution guide for HugeGraph:
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:"><meta property="og:type" content="article"><meta property="og:url" content="/cn/docs/contribution-guidelines/contribute/"><meta property="article:section" content="docs"><meta property="article:modified_time" content="2023-01-04T22:59:07+08:00"><meta property="og:site_name" content="HugeGraph"><meta itemprop=name content="如何参与 HugeGraph 社区"><meta itemprop=description content="TODO: translate this article to Chinese
+Before submitting the code, we need to do some preparation:"><meta property="og:type" content="article"><meta property="og:url" content="/cn/docs/contribution-guidelines/contribute/"><meta property="article:section" content="docs"><meta property="article:modified_time" content="2023-06-26T14:59:53+08:00"><meta property="og:site_name" content="HugeGraph"><meta itemprop=name content="如何参与 HugeGraph 社区"><meta itemprop=description content="TODO: translate this article to Chinese
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 the contributors.
The following is a contribution guide for HugeGraph:
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:"><meta itemprop=dateModified content="2023-01-04T22:59:07+08:00"><meta itemprop=wordCount content="823"><meta itemprop=keywords content><meta name=twitter:card content="summary"><meta name=twitter:title content="如何参与 HugeGraph 社区"><meta name=twitter:description content="TODO: translate this article to Chinese
+Before submitting the code, we need to do some preparation:"><meta itemprop=dateModified content="2023-06-26T14:59:53+08:00"><meta itemprop=wordCount content="871"><meta itemprop=keywords content><meta name=twitter:card content="summary"><meta name=twitter:title content="如何参与 HugeGraph 社区"><meta name=twitter:description content="TODO: translate this article to Chinese
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 the contributors.
The following is a contribution guide for HugeGraph:
1. Preparation We can contribute by reporting issues, submitting code patches or any other feedback.
@@ -40,7 +40,7 @@ Before submitting the code, we need to do some preparation:"><link rel=preload h
</span></span><span style=display:flex><span>vim hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># run test locally (optional)</span>
</span></span><span style=display:flex><span>mvn <span style=color:#204a87>test</span> -Pcore-test,memory
-</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href=https://www.jetbrains.com/idea/>IDEA</a> as your IDE, you can directly <a href=https://www.jetbrains.com/help/idea/configuring-code-style.html>import</a> our code style <a href=./hugegraph-style.xml>configuration file</a>.</p><h4 id=33-commit-changes-to-git-repo>3.3 Commit changes to git repo</h4><p>After the code has been completed, we submit them to the local git repo:</p> [...]
+</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href=https://www.jetbrains.com/idea/>IDEA</a> as your IDE, you can directly <a href=https://www.jetbrains.com/help/idea/configuring-code-style.html>import</a> our code style <a href=./hugegraph-style.xml>configuration file</a>.</p><h5 id=321-添加第三方依赖>3.2.1 添加第三方依赖</h5><p>如果我们要在 <code>HugeGraph</code> 项目中添加新的第三方依赖, 我们需要做下面的几件事情：</p><ol><li>找到第三方依赖的仓库，将依赖的 <code>license</code> 文件放到 [...]
</span></span><span style=display:flex><span>git add hugegraph-core/src/main/java/org/apache/hugegraph/HugeGraph.java
</span></span><span style=display:flex><span>git add hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># commit to local git repo</span>
@@ -65,7 +65,7 @@ Before submitting the code, we need to do some preparation:"><link rel=preload h
</span></span><span style=display:flex><span>git rebase -i master
</span></span></code></pre></div></blockquote><p>And push it to GitHub fork repo again:</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-shell data-lang=shell><span style=display:flex><span><span style=color:#8f5902;font-style:italic># force push the local commit to fork repo</span>
</span></span><span style=display:flex><span>git push -f origin bugfix-branch:bugfix-branch
-</span></span></code></pre></div><p>GitHub will automatically update the Pull Request after we push it, just wait for code review.</p><style>.feedback--answer{display:inline-block}.feedback--answer-no{margin-left:1em}.feedback--response{display:none;margin-top:1em}.feedback--response__visible{display:block}</style><script>const yesButton=document.querySelector(".feedback--answer-yes"),noButton=document.querySelector(".feedback--answer-no"),yesResponse=document.querySelector(".feedback--r [...]
+</span></span></code></pre></div><p>GitHub will automatically update the Pull Request after we push it, just wait for code review.</p><style>.feedback--answer{display:inline-block}.feedback--answer-no{margin-left:1em}.feedback--response{display:none;margin-top:1em}.feedback--response__visible{display:block}</style><script>const yesButton=document.querySelector(".feedback--answer-yes"),noButton=document.querySelector(".feedback--answer-no"),yesResponse=document.querySelector(".feedback--r [...]
<script src=https://cdn.jsdelivr.net/npm/bootstrap@4.6.1/dist/js/bootstrap.min.js integrity="sha512-UR25UO94eTnCVwjbXozyeVd6ZqpaAE9naiEUBK/A+QDbfSTQFhPGj5lOR6d8tsgbBk84Ggb5A3EkjsOgPRPcKA==" crossorigin=anonymous></script>
<script src=/js/tabpane-persist.js></script>
<script src=/js/main.min.aa9f4c5dae6a98b2c46277f4c56f1673a2b000d1756ce4ffae93784cab25e6d5.js integrity="sha256-qp9MXa5qmLLEYnf0xW8Wc6KwANF1bOT/rpN4TKsl5tU=" crossorigin=anonymous></script>
diff --git a/cn/docs/contribution-guidelines/index.xml b/cn/docs/contribution-guidelines/index.xml
index 9754c27a..757af8ba 100644
--- a/cn/docs/contribution-guidelines/index.xml
+++ b/cn/docs/contribution-guidelines/index.xml
@@ -52,6 +52,21 @@
</span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># run test locally (optional)</span>
</span></span><span style="display:flex;"><span>mvn <span style="color:#204a87">test</span> -Pcore-test,memory
</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href="https://www.jetbrains.com/idea/">IDEA</a> as your IDE, you can directly <a href="https://www.jetbrains.com/help/idea/configuring-code-style.html">import</a> our code style <a href="./hugegraph-style.xml">configuration file</a>.</p>
+<h5 id="321-添加第三方依赖">3.2.1 添加第三方依赖</h5>
+<p>如果我们要在 <code>HugeGraph</code> 项目中添加新的第三方依赖, 我们需要做下面的几件事情：</p>
+<ol>
+<li>找到第三方依赖的仓库，将依赖的 <code>license</code> 文件放到 <a href="https://github.com/apache/incubator-hugegraph/tree/master/hugegraph-dist/release-docs/licenses">./hugegraph-dist/release-docs/licenses/</a> 路径下。</li>
+<li>在<a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/release-docs/LICENSE">./hugegraph-dist/release-docs/LICENSE</a> 中声明该依赖的 <code>LICENSE</code> 信息。</li>
+<li>找到仓库里的 NOTICE 文件，将其追加到 <a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/release-docs/NOTICE">./hugegraph-dist/release-docs/NOTICE</a> 文件后面（如果没有NOTICE文件则跳过这一步）。</li>
+<li>本地执行<a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh">./hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh</a> 脚本来更新依赖列表<a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/scripts/dependency/known-dependencies.txt">known-dependencies.txt</a> (或者手动更新)。</li>
+</ol>
+<p><strong>例如</strong>：在项目中引入了第三方新依赖 -&gt; <code>ant-1.9.1.jar</code></p>
+<ul>
+<li>项目源码位于：https://github.com/apache/ant/tree/rel/1.9.1</li>
+<li>LICENSE 文件：https://github.com/apache/ant/blob/rel/1.9.1/LICENSE</li>
+<li>NOTICE 文件：https://github.com/apache/ant/blob/rel/1.9.1/NOTICE</li>
+</ul>
+<p><code>ant-1.9.1.jar</code> 的 license 信息需要在 LICENSE 文件中指定，notice 信息需要在 NOTICE 文件中指定。 ant-1.9.1.jar 对应的详细 LICENSE 文件需要复制到我们的 licenses/ 目录下。最后更新 known-dependencies.txt 文件。</p>
<h4 id="33-commit-changes-to-git-repo">3.3 Commit changes to git repo</h4>
<p>After the code has been completed, we submit them to the local git repo:</p>
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># add files to local git index</span>
diff --git a/cn/docs/index.xml b/cn/docs/index.xml
index 8f103674..e991c72b 100644
--- a/cn/docs/index.xml
+++ b/cn/docs/index.xml
@@ -2352,6 +2352,21 @@ HugeGraph支持多用户并行操作，用户可输入Gremlin查询语句，并
</span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># run test locally (optional)</span>
</span></span><span style="display:flex;"><span>mvn <span style="color:#204a87">test</span> -Pcore-test,memory
</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href="https://www.jetbrains.com/idea/">IDEA</a> as your IDE, you can directly <a href="https://www.jetbrains.com/help/idea/configuring-code-style.html">import</a> our code style <a href="./hugegraph-style.xml">configuration file</a>.</p>
+<h5 id="321-添加第三方依赖">3.2.1 添加第三方依赖</h5>
+<p>如果我们要在 <code>HugeGraph</code> 项目中添加新的第三方依赖, 我们需要做下面的几件事情：</p>
+<ol>
+<li>找到第三方依赖的仓库，将依赖的 <code>license</code> 文件放到 <a href="https://github.com/apache/incubator-hugegraph/tree/master/hugegraph-dist/release-docs/licenses">./hugegraph-dist/release-docs/licenses/</a> 路径下。</li>
+<li>在<a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/release-docs/LICENSE">./hugegraph-dist/release-docs/LICENSE</a> 中声明该依赖的 <code>LICENSE</code> 信息。</li>
+<li>找到仓库里的 NOTICE 文件，将其追加到 <a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/release-docs/NOTICE">./hugegraph-dist/release-docs/NOTICE</a> 文件后面（如果没有NOTICE文件则跳过这一步）。</li>
+<li>本地执行<a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh">./hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh</a> 脚本来更新依赖列表<a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/scripts/dependency/known-dependencies.txt">known-dependencies.txt</a> (或者手动更新)。</li>
+</ol>
+<p><strong>例如</strong>：在项目中引入了第三方新依赖 -&gt; <code>ant-1.9.1.jar</code></p>
+<ul>
+<li>项目源码位于：https://github.com/apache/ant/tree/rel/1.9.1</li>
+<li>LICENSE 文件：https://github.com/apache/ant/blob/rel/1.9.1/LICENSE</li>
+<li>NOTICE 文件：https://github.com/apache/ant/blob/rel/1.9.1/NOTICE</li>
+</ul>
+<p><code>ant-1.9.1.jar</code> 的 license 信息需要在 LICENSE 文件中指定，notice 信息需要在 NOTICE 文件中指定。 ant-1.9.1.jar 对应的详细 LICENSE 文件需要复制到我们的 licenses/ 目录下。最后更新 known-dependencies.txt 文件。</p>
<h4 id="33-commit-changes-to-git-repo">3.3 Commit changes to git repo</h4>
<p>After the code has been completed, we submit them to the local git repo:</p>
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># add files to local git index</span>
diff --git a/cn/sitemap.xml b/cn/sitemap.xml
index ec09332d..31f4c126 100644
--- a/cn/sitemap.xml
+++ b/cn/sitemap.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>/cn/docs/guides/architectural/</loc><lastmod>2023-06-25T21:06:07+08:00</lastmod><xhtml:link rel="alternate" hreflang="en" href="/docs/guides/architectural/"/><xhtml:link rel="alternate" hreflang="cn" href="/cn/docs/guides/architectural/"/></url><url><loc>/cn/docs/config/config-guide/</loc><lastmod>2023-06-21T14:48:04+08:00 [...]
\ No newline at end of file
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>/cn/docs/guides/architectural/</loc><lastmod>2023-06-25T21:06:07+08:00</lastmod><xhtml:link rel="alternate" hreflang="en" href="/docs/guides/architectural/"/><xhtml:link rel="alternate" hreflang="cn" href="/cn/docs/guides/architectural/"/></url><url><loc>/cn/docs/config/config-guide/</loc><lastmod>2023-06-21T14:48:04+08:00 [...]
\ No newline at end of file
diff --git a/docs/_print/index.html b/docs/_print/index.html
index bfd35d1b..064f987f 100644
--- a/docs/_print/index.html
+++ b/docs/_print/index.html
@@ -6492,7 +6492,7 @@ Merging mode as needed, and when the Restore is completed, restore the graph mod
</span></span><span style=display:flex><span>vim hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># run test locally (optional)</span>
</span></span><span style=display:flex><span>mvn <span style=color:#204a87>test</span> -Pcore-test,memory
-</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href=https://www.jetbrains.com/idea/>IDEA</a> as your IDE, you can directly <a href=https://www.jetbrains.com/help/idea/configuring-code-style.html>import</a> our code style <a href=./hugegraph-style.xml>configuration file</a>.</p><h4 id=33-commit-changes-to-git-repo>3.3 Commit changes to git repo</h4><p>After the code has been completed, we submit them to the local git repo:</p> [...]
+</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href=https://www.jetbrains.com/idea/>IDEA</a> as your IDE, you can directly <a href=https://www.jetbrains.com/help/idea/configuring-code-style.html>import</a> our code style <a href=./hugegraph-style.xml>configuration file</a>.</p><h5 id=321-check-licenses>3.2.1 Check licenses</h5><p>If we want to add new third-party dependencies to the <code>HugeGraph</code> project, we need to [...]
</span></span><span style=display:flex><span>git add hugegraph-core/src/main/java/org/apache/hugegraph/HugeGraph.java
</span></span><span style=display:flex><span>git add hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># commit to local git repo</span>
diff --git a/docs/contribution-guidelines/_print/index.html b/docs/contribution-guidelines/_print/index.html
index a8b9db73..45426000 100644
--- a/docs/contribution-guidelines/_print/index.html
+++ b/docs/contribution-guidelines/_print/index.html
@@ -21,7 +21,7 @@
</span></span><span style=display:flex><span>vim hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># run test locally (optional)</span>
</span></span><span style=display:flex><span>mvn <span style=color:#204a87>test</span> -Pcore-test,memory
-</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href=https://www.jetbrains.com/idea/>IDEA</a> as your IDE, you can directly <a href=https://www.jetbrains.com/help/idea/configuring-code-style.html>import</a> our code style <a href=./hugegraph-style.xml>configuration file</a>.</p><h4 id=33-commit-changes-to-git-repo>3.3 Commit changes to git repo</h4><p>After the code has been completed, we submit them to the local git repo:</p> [...]
+</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href=https://www.jetbrains.com/idea/>IDEA</a> as your IDE, you can directly <a href=https://www.jetbrains.com/help/idea/configuring-code-style.html>import</a> our code style <a href=./hugegraph-style.xml>configuration file</a>.</p><h5 id=321-check-licenses>3.2.1 Check licenses</h5><p>If we want to add new third-party dependencies to the <code>HugeGraph</code> project, we need to [...]
</span></span><span style=display:flex><span>git add hugegraph-core/src/main/java/org/apache/hugegraph/HugeGraph.java
</span></span><span style=display:flex><span>git add hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># commit to local git repo</span>
diff --git a/docs/contribution-guidelines/contribute/index.html b/docs/contribution-guidelines/contribute/index.html
index a4296f11..984852b1 100644
--- a/docs/contribution-guidelines/contribute/index.html
+++ b/docs/contribution-guidelines/contribute/index.html
@@ -2,11 +2,11 @@
The following is a contribution guide for HugeGraph:
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:
-Sign up or login to GitHub: https://github.com"><meta property="og:type" content="article"><meta property="og:url" content="/docs/contribution-guidelines/contribute/"><meta property="article:section" content="docs"><meta property="article:modified_time" content="2023-01-04T22:59:07+08:00"><meta property="og:site_name" content="HugeGraph"><meta itemprop=name content="How to Contribute to HugeGraph"><meta itemprop=description content="Thanks for taking the time to contribute! As an open so [...]
+Sign up or login to GitHub: https://github.com"><meta property="og:type" content="article"><meta property="og:url" content="/docs/contribution-guidelines/contribute/"><meta property="article:section" content="docs"><meta property="article:modified_time" content="2023-06-26T14:59:53+08:00"><meta property="og:site_name" content="HugeGraph"><meta itemprop=name content="How to Contribute to HugeGraph"><meta itemprop=description content="Thanks for taking the time to contribute! As an open so [...]
The following is a contribution guide for HugeGraph:
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:
-Sign up or login to GitHub: https://github.com"><meta itemprop=dateModified content="2023-01-04T22:59:07+08:00"><meta itemprop=wordCount content="817"><meta itemprop=keywords content><meta name=twitter:card content="summary"><meta name=twitter:title content="How to Contribute to HugeGraph"><meta name=twitter:description content="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 al [...]
+Sign up or login to GitHub: https://github.com"><meta itemprop=dateModified content="2023-06-26T14:59:53+08:00"><meta itemprop=wordCount content="965"><meta itemprop=keywords content><meta name=twitter:card content="summary"><meta name=twitter:title content="How to Contribute to HugeGraph"><meta name=twitter:description content="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 al [...]
The following is a contribution guide for HugeGraph:
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:
@@ -37,7 +37,7 @@ Sign up or login to GitHub: https://github.com"><link rel=preload href=/scss/mai
</span></span><span style=display:flex><span>vim hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># run test locally (optional)</span>
</span></span><span style=display:flex><span>mvn <span style=color:#204a87>test</span> -Pcore-test,memory
-</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href=https://www.jetbrains.com/idea/>IDEA</a> as your IDE, you can directly <a href=https://www.jetbrains.com/help/idea/configuring-code-style.html>import</a> our code style <a href=./hugegraph-style.xml>configuration file</a>.</p><h4 id=33-commit-changes-to-git-repo>3.3 Commit changes to git repo</h4><p>After the code has been completed, we submit them to the local git repo:</p> [...]
+</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href=https://www.jetbrains.com/idea/>IDEA</a> as your IDE, you can directly <a href=https://www.jetbrains.com/help/idea/configuring-code-style.html>import</a> our code style <a href=./hugegraph-style.xml>configuration file</a>.</p><h5 id=321-check-licenses>3.2.1 Check licenses</h5><p>If we want to add new third-party dependencies to the <code>HugeGraph</code> project, we need to [...]
</span></span><span style=display:flex><span>git add hugegraph-core/src/main/java/org/apache/hugegraph/HugeGraph.java
</span></span><span style=display:flex><span>git add hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java
</span></span><span style=display:flex><span><span style=color:#8f5902;font-style:italic># commit to local git repo</span>
@@ -62,7 +62,7 @@ Sign up or login to GitHub: https://github.com"><link rel=preload href=/scss/mai
</span></span><span style=display:flex><span>git rebase -i master
</span></span></code></pre></div></blockquote><p>And push it to GitHub fork repo again:</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-shell data-lang=shell><span style=display:flex><span><span style=color:#8f5902;font-style:italic># force push the local commit to fork repo</span>
</span></span><span style=display:flex><span>git push -f origin bugfix-branch:bugfix-branch
-</span></span></code></pre></div><p>GitHub will automatically update the Pull Request after we push it, just wait for code review.</p><style>.feedback--answer{display:inline-block}.feedback--answer-no{margin-left:1em}.feedback--response{display:none;margin-top:1em}.feedback--response__visible{display:block}</style><script>const yesButton=document.querySelector(".feedback--answer-yes"),noButton=document.querySelector(".feedback--answer-no"),yesResponse=document.querySelector(".feedback--r [...]
+</span></span></code></pre></div><p>GitHub will automatically update the Pull Request after we push it, just wait for code review.</p><style>.feedback--answer{display:inline-block}.feedback--answer-no{margin-left:1em}.feedback--response{display:none;margin-top:1em}.feedback--response__visible{display:block}</style><script>const yesButton=document.querySelector(".feedback--answer-yes"),noButton=document.querySelector(".feedback--answer-no"),yesResponse=document.querySelector(".feedback--r [...]
<script src=https://cdn.jsdelivr.net/npm/bootstrap@4.6.1/dist/js/bootstrap.min.js integrity="sha512-UR25UO94eTnCVwjbXozyeVd6ZqpaAE9naiEUBK/A+QDbfSTQFhPGj5lOR6d8tsgbBk84Ggb5A3EkjsOgPRPcKA==" crossorigin=anonymous></script>
<script src=/js/tabpane-persist.js></script>
<script src=/js/main.min.aa9f4c5dae6a98b2c46277f4c56f1673a2b000d1756ce4ffae93784cab25e6d5.js integrity="sha256-qp9MXa5qmLLEYnf0xW8Wc6KwANF1bOT/rpN4TKsl5tU=" crossorigin=anonymous></script>
diff --git a/docs/contribution-guidelines/index.xml b/docs/contribution-guidelines/index.xml
index 40bd3b25..49e55da8 100644
--- a/docs/contribution-guidelines/index.xml
+++ b/docs/contribution-guidelines/index.xml
@@ -49,6 +49,21 @@
</span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># run test locally (optional)</span>
</span></span><span style="display:flex;"><span>mvn <span style="color:#204a87">test</span> -Pcore-test,memory
</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href="https://www.jetbrains.com/idea/">IDEA</a> as your IDE, you can directly <a href="https://www.jetbrains.com/help/idea/configuring-code-style.html">import</a> our code style <a href="./hugegraph-style.xml">configuration file</a>.</p>
+<h5 id="321-check-licenses">3.2.1 Check licenses</h5>
+<p>If we want to add new third-party dependencies to the <code>HugeGraph</code> project, we need to do the following things:</p>
+<ol>
+<li>Find the third-party dependent repository, put the dependent <code>license</code> file into <a href="https://github.com/apache/incubator-hugegraph/tree/master/hugegraph-dist/release-docs/licenses">./hugegraph-dist/release-docs/licenses/</a> path.</li>
+<li>Declare the dependency in <a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/release-docs/LICENSE">./hugegraph-dist/release-docs/LICENSE</a> <code>LICENSE</code> information.</li>
+<li>Find the NOTICE file in the repository and append it to <a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/release-docs/NOTICE">./hugegraph-dist/release-docs/NOTICE</a> file (skip this step if there is no NOTICE file).</li>
+<li>Execute locally <a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh">./hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh</a> to update the dependency list <a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/scripts/dependency/known-dependencies.txt">known-dependencies.txt</a> (or manually update) .</li>
+</ol>
+<p><strong>Example</strong>: A new third-party dependency is introduced into the project -&gt; <code>ant-1.9.1.jar</code></p>
+<ul>
+<li>The project source code is located at: <a href="https://github.com/apache/ant/tree/rel/1.9.1">https://github.com/apache/ant/tree/rel/1.9.1</a></li>
+<li>LICENSE file: <a href="https://github.com/apache/ant/blob/rel/1.9.1/LICENSE">https://github.com/apache/ant/blob/rel/1.9.1/LICENSE</a></li>
+<li>NOTICE file: <a href="https://github.com/apache/ant/blob/rel/1.9.1/NOTICE">https://github.com/apache/ant/blob/rel/1.9.1/NOTICE</a></li>
+</ul>
+<p>The license information of <code>ant-1.9.1.jar</code> 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.</p>
<h4 id="33-commit-changes-to-git-repo">3.3 Commit changes to git repo</h4>
<p>After the code has been completed, we submit them to the local git repo:</p>
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># add files to local git index</span>
diff --git a/docs/index.xml b/docs/index.xml
index 064af07d..054f91c4 100644
--- a/docs/index.xml
+++ b/docs/index.xml
@@ -863,6 +863,21 @@
</span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># run test locally (optional)</span>
</span></span><span style="display:flex;"><span>mvn <span style="color:#204a87">test</span> -Pcore-test,memory
</span></span></code></pre></div><p>Note: In order to be consistent with the code style easily, if you use <a href="https://www.jetbrains.com/idea/">IDEA</a> as your IDE, you can directly <a href="https://www.jetbrains.com/help/idea/configuring-code-style.html">import</a> our code style <a href="./hugegraph-style.xml">configuration file</a>.</p>
+<h5 id="321-check-licenses">3.2.1 Check licenses</h5>
+<p>If we want to add new third-party dependencies to the <code>HugeGraph</code> project, we need to do the following things:</p>
+<ol>
+<li>Find the third-party dependent repository, put the dependent <code>license</code> file into <a href="https://github.com/apache/incubator-hugegraph/tree/master/hugegraph-dist/release-docs/licenses">./hugegraph-dist/release-docs/licenses/</a> path.</li>
+<li>Declare the dependency in <a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/release-docs/LICENSE">./hugegraph-dist/release-docs/LICENSE</a> <code>LICENSE</code> information.</li>
+<li>Find the NOTICE file in the repository and append it to <a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/release-docs/NOTICE">./hugegraph-dist/release-docs/NOTICE</a> file (skip this step if there is no NOTICE file).</li>
+<li>Execute locally <a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh">./hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh</a> to update the dependency list <a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/scripts/dependency/known-dependencies.txt">known-dependencies.txt</a> (or manually update) .</li>
+</ol>
+<p><strong>Example</strong>: A new third-party dependency is introduced into the project -&gt; <code>ant-1.9.1.jar</code></p>
+<ul>
+<li>The project source code is located at: <a href="https://github.com/apache/ant/tree/rel/1.9.1">https://github.com/apache/ant/tree/rel/1.9.1</a></li>
+<li>LICENSE file: <a href="https://github.com/apache/ant/blob/rel/1.9.1/LICENSE">https://github.com/apache/ant/blob/rel/1.9.1/LICENSE</a></li>
+<li>NOTICE file: <a href="https://github.com/apache/ant/blob/rel/1.9.1/NOTICE">https://github.com/apache/ant/blob/rel/1.9.1/NOTICE</a></li>
+</ul>
+<p>The license information of <code>ant-1.9.1.jar</code> 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.</p>
<h4 id="33-commit-changes-to-git-repo">3.3 Commit changes to git repo</h4>
<p>After the code has been completed, we submit them to the local git repo:</p>
<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># add files to local git index</span>
diff --git a/en/sitemap.xml b/en/sitemap.xml
index eec84dec..90c9797b 100644
--- a/en/sitemap.xml
+++ b/en/sitemap.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>/docs/guides/architectural/</loc><lastmod>2023-06-25T21:06:07+08:00</lastmod><xhtml:link rel="alternate" hreflang="cn" href="/cn/docs/guides/architectural/"/><xhtml:link rel="alternate" hreflang="en" href="/docs/guides/architectural/"/></url><url><loc>/docs/config/config-guide/</loc><lastmod>2023-06-21T14:48:04+08:00</last [...]
\ No newline at end of file
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>/docs/guides/architectural/</loc><lastmod>2023-06-25T21:06:07+08:00</lastmod><xhtml:link rel="alternate" hreflang="cn" href="/cn/docs/guides/architectural/"/><xhtml:link rel="alternate" hreflang="en" href="/docs/guides/architectural/"/></url><url><loc>/docs/config/config-guide/</loc><lastmod>2023-06-21T14:48:04+08:00</last [...]
\ No newline at end of file
diff --git a/sitemap.xml b/sitemap.xml
index 087e51af..2bc29d89 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?><sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><sitemap><loc>/en/sitemap.xml</loc><lastmod>2023-06-25T21:06:46+08:00</lastmod></sitemap><sitemap><loc>/cn/sitemap.xml</loc><lastmod>2023-06-25T21:06:46+08:00</lastmod></sitemap></sitemapindex>
\ No newline at end of file
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><sitemap><loc>/en/sitemap.xml</loc><lastmod>2023-06-26T14:59:53+08:00</lastmod></sitemap><sitemap><loc>/cn/sitemap.xml</loc><lastmod>2023-06-26T14:59:53+08:00</lastmod></sitemap></sitemapindex>
\ No newline at end of file