Skip to content

Rewrite the README document #8214

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

Merged
merged 1 commit into from
Mar 1, 2024
Merged

Rewrite the README document #8214

merged 1 commit into from
Mar 1, 2024

Conversation

Turbo87
Copy link
Member

@Turbo87 Turbo87 commented Feb 29, 2024

Bildschirmfoto 2024-02-29 um 18 38 53

Previously, about 50% of our README document was dedicated to "Categories", while missing quite a few more relevant parts. This PR updates our README with:

  • a nice logo at the top
  • a couple of quicklinks to our policies, the status page, and other important places
  • an short overview of what crates.io is
  • a sentence about our primary infrastructure sponsors
  • an explanation about our split between GitHub Issues (for bugs) and Discussions (for feature proposals/requests)
  • a "Code of Conduct" section

A rendered preview is available at https://github.com/Turbo87/crates.io/blob/readme/README.md

@Turbo87 Turbo87 added the C-documentation 📜 Category: Documentation of crates.io itself label Feb 29, 2024
@Turbo87 Turbo87 requested a review from a team February 29, 2024 18:18
@Turbo87 Turbo87 force-pushed the readme branch 2 times, most recently from 9c5d88c to 022c2e2 Compare February 29, 2024 18:24
Copy link

codecov bot commented Feb 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.56%. Comparing base (8521cee) to head (022c2e2).

❗ Current head 022c2e2 differs from pull request most recent head 907c146. Consider uploading reports for the commit 907c146 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #8214   +/-   ##
=======================================
  Coverage   87.56%   87.56%           
=======================================
  Files         271      271           
  Lines       26983    26983           
=======================================
  Hits        23628    23628           
  Misses       3355     3355           

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

Copy link
Contributor

@LawnGnome LawnGnome left a comment

Choose a reason for hiding this comment

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

I like this!

A couple of suggestions, but you can take or leave them as you wish.

@Turbo87 Turbo87 enabled auto-merge (squash) March 1, 2024 07:44
@Turbo87 Turbo87 merged commit 8a3989d into rust-lang:main Mar 1, 2024
@Turbo87 Turbo87 deleted the readme branch March 1, 2024 07:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-documentation 📜 Category: Documentation of crates.io itself
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants