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

Merged
merged 3 commits into from
May 28, 2024

Conversation

ZeeJJ123
Copy link
Contributor

@ZeeJJ123 ZeeJJ123 commented May 16, 2024

Add #contributing section and update the correct CONTRIBUTING.md URL.

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:
    • xxx

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

Add #contributing section and update the correct contribute URL.
@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label May 16, 2024
README.md Outdated Show resolved Hide resolved
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.

plz rebase after #605 merged

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.
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
@ZeeJJ123 ZeeJJ123 changed the title Update READ.ME Add Contributing Section and Update CONTRIBUTING.md Link May 24, 2024
- 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 review from JackyYangPassion and liuxiaocs7 and removed request for liuxiaocs7 May 28, 2024 04:58
@liuxiaocs7 liuxiaocs7 merged commit f6588bd into apache:master May 28, 2024
8 checks passed
@ZeeJJ123 ZeeJJ123 changed the title Add Contributing Section and Update CONTRIBUTING.md Link 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
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