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

doc(readme): clarify the contributing guidelines #143

Merged
merged 2 commits into from
May 28, 2024

Conversation

ZeeJJ123
Copy link
Contributor

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'.

…k 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'.
@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. enhancement New feature or request labels May 22, 2024
README.md Outdated
- Welcome to contribute to HugeGraph, please see [`How to Contribute`](CONTRIBUTING.md) & [Guidelines](https://hugegraph.apache.org/docs/contribution-guidelines/) 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.
Copy link
Member

@imbajin imbajin May 24, 2024

Choose a reason for hiding this comment

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

seems we should leave the website page as the latest version instead of using hugegraph-server's doc

so as other repos (toolchain/computer)

- 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.
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label May 28, 2024
@imbajin imbajin requested a review from liuxiaocs7 May 28, 2024 05:03
Copy link
Member

@liuxiaocs7 liuxiaocs7 left a comment

Choose a reason for hiding this comment

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

+1, Thanks

@liuxiaocs7 liuxiaocs7 merged commit 93c2e08 into apache:master May 28, 2024
7 checks passed
@ZeeJJ123 ZeeJJ123 changed the title Update 'How to Contribute' link and remove duplicate 'Guidelines' link in README doc(readme): clarify the contributing guidelines May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants