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 #306

Merged
merged 2 commits into from
May 28, 2024

Conversation

ZeeJJ123
Copy link
Contributor

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.

Purpose of the PR

  • close #xxx

Main Changes

Verifying these changes

  • Trivial rework / code cleanup without any test coverage. (No Need)
  • Already covered by existing tests, such as (please modify tests here).
  • Need tests and can be verified as follows.

Does this PR potentially affect the following parts?

  • Nope
  • Dependencies (add/update license info)
  • Modify configurations
  • The public API
  • Other affects (typed here)

Documentation Status

  • Doc - TODO
  • Doc - Done
  • Doc - No Need

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.
@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. documentation Improvements or additions to documentation labels May 22, 2024
imbajin
imbajin previously approved these changes May 24, 2024
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label May 24, 2024
@imbajin imbajin requested a review from liuxiaocs7 May 24, 2024 15:02
- 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.
@imbajin imbajin requested a review from coderzc May 28, 2024 05:04
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 requested review from coderzc and removed request for coderzc May 28, 2024 07:24
@ZeeJJ123 ZeeJJ123 changed the title Clarify the Contributing Guidelines in README doc(readme): clarify the contributing guidelines May 28, 2024
@liuxiaocs7 liuxiaocs7 merged commit 28c29f5 into apache:master May 28, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 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