anph
/
hugegraph-sync
forked from hugegraph/hugegraph-sync
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
216 Commits 28 Branches 17 Tags 69 MiB
Java 98.4%
Shell 1.5%
Go to file
Zee Huang 93c2e08780
Update 'How to Contribute' link and remove duplicate 'Guidelines' link in README (#143) 
* Update 'How to Contribute' link and remove duplicate 'Guidelines' link in README

This PR makes the following changes to the README file to streamline the contribution guidelines and avoid redundancy:

- Updated the 'How to Contribute' link to ensure it directs contributors to the correct resource.
- Removed the 'Guidelines' link as it duplicated the information provided in 'How to Contribute'.

* Update contribution link from markdown to website

- Changed the contribution guide link in the README.md from the markdown file to the corresponding section on the official website.
- This change ensures that the link remains stable and is not impacted by the frequent changes to Markdown files.
 		2024-05-28 15:22:43 +08:00
.github feat(common): replace jersey dependencies with OkHttp (Breaking Change) (#133) 2023-11-22 09:37:02 +08:00
hugegraph-common feat: support user defined RestClientConfig/HTTPClient params (#140) 2024-03-13 20:13:01 +08:00
hugegraph-dist update licence (#139) 2023-12-17 15:35:03 +08:00
hugegraph-rpc feat: support user defined RestClientConfig/HTTPClient params (#140) 2024-03-13 20:13:01 +08:00
style chore: remove copyright in file header & fix some files 2023-01-14 02:07:18 +08:00
.asf.yaml chore: enable rebase option (#121) 2022-12-05 00:05:14 +08:00
.editorconfig feat: support user defined RestClientConfig/HTTPClient params (#140) 2024-03-13 20:13:01 +08:00
.gitattributes fix: add style files back (#125) 2023-01-01 13:18:07 +08:00
.gitignore chore: update release script & add mailing lists (#123) 2022-12-15 16:14:29 +08:00
.licenserc.yaml chore(license): fix 3rd party refer code (#127) 2023-02-04 01:52:42 +08:00
DISCLAIMER chore: add DISCLAIMER & NOTICE & LICENSE file to binary package 2023-01-14 02:07:18 +08:00
LICENSE chore: fix copyright year and format 2023-01-14 02:07:18 +08:00
NOTICE chore: fix copyright year and format 2023-01-14 02:07:18 +08:00
README.md Update 'How to Contribute' link and remove duplicate 'Guidelines' link in README (#143) 2024-05-28 15:22:43 +08:00
pom.xml chore: disable clean flatten for deploy (#141) 2024-03-13 20:27:00 +08:00

README.md

hugegraph-commons

License codecov Maven Central CodeQL hugegraph-commons ci

hugegraph-commons is a common module for HugeGraph and its peripheral components. hugegraph-commons encapsulates locks, configurations, events, iterators, rest and some numeric or collection util classes to simplify the development of HugeGraph and its components.

Components

  • Lock: atomic lock, key lock, lock group and lock manger
  • Config: register and load config option with security check
  • Event: listening and notification, do something asynchronously
  • Iterator: some iterators with extra functions, map, filter, extend, etc.
  • Rest: RESTful client implemented on OkHttp, POST, PUT, GET and DELETE
  • Util: performance analyzer, version checker, numeric and Collection utils, log and exception utils, etc.
  • Rpc: rpc component for inner module communication, currently it's based on Sofa-RPC

You could use import the dependencies in maven like this:

  <dependency>
       <groupId>org.apache.hugegraph</groupId>
       <artifactId>hugegraph-common</artifactId>
       <version>1.2.0</version>
  </dependency>

Learn More

The doc page contains more information about hugegraph modules.

And here are links of other repositories:

  1. hugegraph-server (graph's core component - OLTP server)
  2. hugegraph-toolchain (include loader/dashboard/tool/client)
  3. hugegraph-computer (graph processing system - OLAP)
  4. hugegraph-website/doc (include doc & website code)

Contributing

  • Welcome to contribute to HugeGraph, please see How to Contribute for more information.
  • Note: It's recommended to use GitHub Desktop to greatly simplify the PR and commit process.
  • Thank you to all the people who already contributed to HugeGraph!

contributors graph

Licence

Same as HugeGraph, hugegraph-commons are also licensed under Apache 2.0 License.

Contact Us

QR png