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

docs: revise contribution guidelines for clarity and inclusivity #1831

Merged
merged 1 commit into from
Mar 29, 2024

Conversation

aofei
Copy link
Member

@aofei aofei commented Mar 29, 2024

As our project grows, we want to ensure that our community understands how to contribute effectively and feels welcomed to do so. This update to our contribution guidelines aims to clarify the process and encourage more developers to get involved.

Key changes include:

  • Simplified the language to make the guidelines more accessible to non-native English speakers and newcomers to open source.
  • Included a step-by-step guide on setting up the development environment, submitting a pull request, and what to expect during the review process.
  • Added a new section on community standards and code of conduct to foster a respectful and inclusive community atmosphere.
  • Provided clear examples of desirable contributions, such as bug fixes, feature proposals, and documentation improvements.

Updates #1829


There may be more content to add here, but I've written down the main points as a foundation. I suggest giving it a thorough read before merging.

As our project grows, we want to ensure that our community understands
how to contribute effectively and feels welcomed to do so. This update
to our contribution guidelines aims to clarify the process and encourage
more developers to get involved.

Key changes include:
  - Simplified the language to make the guidelines more accessible to
    non-native English speakers and newcomers to open source.
  - Included a step-by-step guide on setting up the development
    environment, submitting a pull request, and what to expect during
    the review process.
  - Added a new section on community standards and code of conduct to
    foster a respectful and inclusive community atmosphere.
  - Provided clear examples of desirable contributions, such as bug
    fixes, feature proposals, and documentation improvements.

Updates goplus#1829

Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
Copy link

codecov bot commented Mar 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.57%. Comparing base (0a7dbfe) to head (bfae6ef).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1831   +/-   ##
=======================================
  Coverage   92.57%   92.57%           
=======================================
  Files          42       42           
  Lines       11418    11418           
=======================================
  Hits        10570    10570           
  Misses        686      686           
  Partials      162      162           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@xushiwei xushiwei merged commit 82ff6d7 into goplus:main Mar 29, 2024
18 checks passed
@aofei aofei deleted the contributing branch April 1, 2024 01:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants