Add Contributing Section and Update CONTRIBUTING.md Link (#604)

* Update READ.ME

Add #contributing section and update the correct contribute URL.

* Remove 'Guidelines' link from the 'Contributing' section

I have removed the hyperlink and reference to 'Guidelines' in the README.md file. This change was made because the 'How to Contribute' and 'Guidelines' links led to the same information, creating redundancy.

* 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.
1 file changed
tree: 782244f27834d5a72fe07b1e828362add6633a81
  1. .github/
  2. .idea/
  3. assembly/
  4. hugegraph-client/
  5. hugegraph-client-go/
  6. hugegraph-dist/
  7. hugegraph-hubble/
  8. hugegraph-loader/
  9. hugegraph-spark-connector/
  10. hugegraph-tools/
  11. tools/
  12. .asf.yaml
  13. .editorconfig
  14. .gitattributes
  15. .gitignore
  16. .licenserc.yaml
  17. DISCLAIMER
  18. LICENSE
  19. NOTICE
  20. pom.xml
  21. README.md
README.md

hugegraph-toolchain

License Build Status Build Status Build Status Build Status Maven Central

hugegraph-toolchain is the integration project contains a series of utilities for HugeGraph, it includes 5+ main modules.

Modules

  • hugegraph-loader: Loading datasets into the HugeGraph from multiple data sources.
  • hugegraph-hubble: Online HugeGraph management and analysis dashboard (Include: data loading, schema management, graph traverser and display).
  • hugegraph-tools: Command line tool for deploying, managing and backing-up/restoring graphs from HugeGraph.
  • hugegraph-client: A Java-written client for HugeGraph, providing RESTful APIs for accessing graph vertex/edge/schema/gremlin/variables and traversals etc.
  • hugegraph-client-go: A Go-written client for HugeGraph, providing RESTful APIs for accessing graph vertex/edge/schema/gremlin/variables and traversals etc. (WIP)

Usage

Maven Dependencies

You could use import the dependencies in maven like this:

  <!-- Note: use the latest release version in maven repo, here is just an example -->
  <dependency>
       <groupId>org.apache.hugegraph</groupId>
       <artifactId>hugegraph-client</artifactId>
       <version>1.3.0</version>
  </dependency>
  
  <dependency>
       <groupId>org.apache.hugegraph</groupId>
       <artifactId>hugegraph-loader</artifactId>
       <version>1.3.0</version>
  </dependency>

Doc

The project homepage contains more information about hugegraph-toolchain.

License

hugegraph-toolchain is licensed under Apache 2.0 License.

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

Contact Us