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

Create APACHE_PROPOSAL.md #1644

Merged
merged 27 commits into from
Dec 21, 2021
Merged

Create APACHE_PROPOSAL.md #1644

merged 27 commits into from
Dec 21, 2021

Conversation

javeme
Copy link
Contributor

@javeme javeme commented Nov 10, 2021

@codecov
Copy link

codecov bot commented Nov 10, 2021

Codecov Report

Merging #1644 (8916909) into master (299449b) will decrease coverage by 0.21%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##             master    #1644      +/-   ##
============================================
- Coverage     66.99%   66.78%   -0.22%     
+ Complexity     7069     7066       -3     
============================================
  Files           421      420       -1     
  Lines         34646    34702      +56     
  Branches       4798     4814      +16     
============================================
- Hits          23210    23174      -36     
- Misses         9094     9188      +94     
+ Partials       2342     2340       -2     
Impacted Files Coverage Δ
...egraph/backend/store/mysql/MysqlStoreProvider.java 33.33% <0.00%> (-66.67%) ⬇️
...aidu/hugegraph/backend/store/mysql/MysqlStore.java 63.95% <0.00%> (-17.77%) ⬇️
...idu/hugegraph/backend/store/mysql/MysqlTables.java 76.51% <0.00%> (-13.17%) ⬇️
...u/hugegraph/backend/store/mysql/MysqlSessions.java 57.89% <0.00%> (-10.53%) ⬇️
...aidu/hugegraph/backend/store/mysql/MysqlTable.java 75.82% <0.00%> (-5.77%) ⬇️
.../algorithm/records/DoubleWayMultiPathsRecords.java 94.18% <0.00%> (-4.58%) ⬇️
.../hugegraph/backend/store/BackendEntryIterator.java 60.75% <0.00%> (-4.03%) ⬇️
...baidu/hugegraph/backend/store/mysql/MysqlUtil.java 93.22% <0.00%> (-3.39%) ⬇️
...va/com/baidu/hugegraph/task/ServerInfoManager.java 71.34% <0.00%> (-2.25%) ⬇️
...om/baidu/hugegraph/backend/query/QueryResults.java 70.09% <0.00%> (-1.07%) ⬇️
... and 41 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 299449b...8916909. Read the comment docs.


## Proposal

HugeGraph is to provide an large-scale graph database, which achieves availability and balance between performance and cost in the scenario of 100+ billion data, and has complete HTAP capabilities in an internal system.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"data, and" has more than one space

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

javeme and others added 3 commits November 15, 2021 16:51
add Orphaned products ~ A Excessive Fascination

We have checked that the name is [suitable](https://github.com/hugegraph/hugegraph/issues/1646) and the project has legal permission to continuing using its current name. There is no one else found using this name through Google search.

#### Orphaned products
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

expect h3 title "###" for "Orphaned products" in latest template: https://cwiki.apache.org/confluence/display/INCUBATOR/New+Podling+Proposal#orphaned-products


#### Orphaned products

Due to the relatively small number of contributors, the project has a relatively small risk of becoming an orphan. However, the contributors have been operating in the spirit of open source for 3 years, and continue to develop new contributors to participate.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use committers here? in order to prevent thinking that there is only 1~2 committers, we make it clear that there are about 10 committers


#### Inexperience with Open Source:

HugeGraph has been open sourced on GitHub for 3 years, during which contributors submitted code and documents in full compliance with open source specifications and requirements
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

contributors -- ditto

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add "." at the end


#### Length of Incubation:

Expect to enter incubation in 6 months and graduate in about 2 years
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add "." at the end

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4 months


Most of the developers are paid by their employer to contribute to this project, but given some volunteer developers and the committers' sense of ownership for the code, the project would continue without issue if no salaried developers contributed to the project.

#### Relationship with Titan/Janus Graph
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

keep the section in "Known Risks" and add a new section to describe "Relationships with Other Apache Products:"


## Abstract

HugeGraph will be a graph database with high performance and scalability.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will be -> is

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done, thanks~

Copy link
Member

@WillemJiang WillemJiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just add some comments on this proposal.


#### Issue Tracking:

We choose JIRA HugeGraph (HUGEGRAPH), and the community would like to continue using [GitHub Issues](https://github.com/hugegraph/hugegraph/issues).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to chose one, it's OK that we still use Github issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, we prefer to still use GitHub Issues


#### External Dependencies:

As all dependencies are managed using Apache Maven, none of the external libraries need to be packaged in a source distribution. All dependencies have Apache compatible licenses except MySQL (GPL-2.0), we will remove MySQL dependencies in future.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the MySQL dependency is optional, we can add some instruction for users to download by themselves.

https://www.apache.org/legal/resolved.html#optional

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the MySQL dependency is optional.
TODO: add some instruction for users to download by themselves

- jersey-inject-hk2
- JSR 353 (JSON Processing) Default Provider

- Commercial License + AGPL License
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to take a look at this dependency. We cannot ship the AGPL third party dependency.
https://www.apache.org/legal/resolved.html#category-x

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: check AGPL dependency


- jBCrypt

- LGPL License
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to take a look at this dependency. We cannot ship the GPL and LGPL third party dependency.
https://www.apache.org/legal/resolved.html#category-x

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: check LGPL dependency


#### Alignment

HugeGraph is compliance to [Apache TinkerPop 3](https://tinkerpop.apache.org/) framework, various complicated graph queries can be accomplished through [Gremlin](https://tinkerpop.apache.org/gremlin.html), a powerful graph traversal language. The TinkerPop ecosystem based on Java is relatively mature in terms of graph databases, we use Java language which is develop efficient and stable to develop upper-level components like graph engine, graph computing, graph api and graph tools; and we manage storage through JNI which is able to freely manage memory and execute efficiently.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

compliance 的翻译有点问题, 是说我们在用TinkerPop API吗?

Copy link
Contributor Author

@javeme javeme Nov 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

想要表达的是"HugeGraph遵循TinkerPop的规范",比如: "完全兼容TinkerPop定义的Gremlin查询语言"。

@CLAassistant
Copy link

CLAassistant commented Nov 18, 2021

CLA assistant check
All committers have signed the CLA.

@imbajin imbajin added this to In progress in Apache Incubation Nov 22, 2021
@imbajin imbajin removed this from In progress in Apache Incubation Nov 22, 2021
@javeme javeme merged commit d0dce7e into master Dec 21, 2021
@javeme javeme deleted the apache-proposal branch December 28, 2021 13:53
@javeme javeme restored the apache-proposal branch December 28, 2021 13:53
@imbajin imbajin deleted the apache-proposal branch October 26, 2023 06:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Apache] prepare proposal
9 participants