Skip to content

Commit

Permalink
doc(readme): clarify the contributing guidelines (#306)
Browse files Browse the repository at this point in the history
* Clarify the Contributing Guidelines in README

This PR updates the 'Contributing' section of the README to enhance clarity and make instructions straightforward for new contributors.

1. Formatted statements with bullet points as in other README files.
2. Updated the 'How to Contribute' link to a valid URL.
3. Added images of contributors.

These changes are intended to make the guide easier to follow and more engaging for new contributors.

* 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.
  • Loading branch information
ZeeJJ123 authored May 28, 2024
1 parent 4d22855 commit 28c29f5
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,11 @@ And here are links of other repositories:

## Contributing

Welcome to contribute, please see [`How to Contribute`](https://github.com/apache/hugegraph/blob/master/CONTRIBUTING.md) for more information
- Welcome to contribute to HugeGraph, please see [How to Contribute](https://hugegraph.apache.org/docs/contribution-guidelines/contribute/) for more information.
- Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) to greatly simplify the PR and commit process.
- Thank you to all the people who already contributed to HugeGraph!

Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) to **greatly simplify** the PR and commit process.
[![contributors graph](https://contrib.rocks/image?repo=apache/hugegraph-computer)](https://github.com/apache/incubator-hugegraph-computer/graphs/contributors)

## License

Expand Down

0 comments on commit 28c29f5

Please sign in to comment.