From ac427ad79f0e5bd66bdfa80b222afdccb56e74e3 Mon Sep 17 00:00:00 2001 From: ZeeJJ123 <136208225+ZeeJJ123@users.noreply.github.com> Date: Wed, 22 May 2024 18:01:41 +0800 Subject: [PATCH 1/2] 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. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cf5fa5eb9..c715484e7 100644 --- a/README.md +++ b/README.md @@ -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://github.com/apache/incubator-hugegraph/blob/master/CONTRIBUTING.md) 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 From b711f429b73143d4f61e9f743a0c66a33134a070 Mon Sep 17 00:00:00 2001 From: ZeeJJ123 <136208225+ZeeJJ123@users.noreply.github.com> Date: Tue, 28 May 2024 00:38:54 +0800 Subject: [PATCH 2/2] 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. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c715484e7..219ccbb9e 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ And here are links of other repositories: ## Contributing -- Welcome to contribute to HugeGraph, please see [How to Contribute](https://github.com/apache/incubator-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!