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

chore: improve README.md layout with badges and colors #10428

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

nsgpriyanshu
Copy link

Please describe the changes this PR makes and why it should be merged:

This pull request enhances the README.md file by introducing the npm logo and two new badges: one for the last commit and one for contributions. These additions provide viewers and contributors with clear information on the latest commit activity and the number of contributors. The badge colors have also been updated for improved contrast and visual appeal, creating a more attractive and informative layout compared to the previous version.

Status and versioning classification:

  • This PR only includes non-code changes, such as updates to documentation and README files.

Enhanced the README.md file by adding the npm logo and two new badges: the last commit and contributions badges. These additions help viewers and coders understand the latest commit activity and the number of contributors. Updated the badge colors to better contrast and look more appealing than the previous ones.
Copy link

vercel bot commented Aug 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
discord-js ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 12, 2024 8:18am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
discord-js-guide ⬜️ Ignored (Inspect) Visit Preview Oct 12, 2024 8:18am

@nsgpriyanshu nsgpriyanshu changed the base branch from main to 14.15.3/debug August 10, 2024 17:19
@nsgpriyanshu nsgpriyanshu requested review from a team as code owners August 10, 2024 17:19
@nsgpriyanshu nsgpriyanshu requested review from didinele, Jiralite and ckohen and removed request for a team August 10, 2024 17:19
@nsgpriyanshu nsgpriyanshu changed the base branch from 14.15.3/debug to main August 11, 2024 01:52
Co-authored-by: Almeida <[email protected]>
Copy link
Member

@vladfrangu vladfrangu left a comment

Choose a reason for hiding this comment

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

Sure, but might make sense to add these to all packages

@nsgpriyanshu
Copy link
Author

Sure, but might make sense to add these to all packages

Okay 👍

@Jiralite Jiralite added the chore label Oct 12, 2024
Comment on lines +13 to +14
<a href="https://github.com/discordjs/discord.js/commits/main"><img src="https://img.shields.io/github/last-commit/discordjs/discord.js.svg?maxAge=3600&logo=github&logoColor=fff" alt="last commit" /></a>
<a href="https://github.com/discordjs/discord.js/graphs/contributors"><img src="https://img.shields.io/github/contributors/discordjs/discord.js.svg?maxAge=3600&logo=github&logoColor=fff&color=00c7be" alt="contributors" /></a>
Copy link
Member

Choose a reason for hiding this comment

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

Is it me, or do I feel this is misleading to put in the discord.js package? It would be fine on the root README.md. Imagine if the most recent commit was to brokers... that's not a commit to here.

Copy link
Author

Choose a reason for hiding this comment

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

Yes, but @vladfrangu told me to add it to all packages.

Copy link
Member

Choose a reason for hiding this comment

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

I'd like to see this addressed before merging. Vlad probably didn't realize

Copy link

codecov bot commented Oct 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 38.03%. Comparing base (24128a3) to head (9a1d51e).
Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10428      +/-   ##
==========================================
+ Coverage   38.00%   38.03%   +0.02%     
==========================================
  Files         239      239              
  Lines       15488    15464      -24     
  Branches     1367     1353      -14     
==========================================
- Hits         5886     5881       -5     
+ Misses       9587     9568      -19     
  Partials       15       15              
Flag Coverage Δ
brokers 31.44% <ø> (ø)
builders 82.43% <ø> (+0.77%) ⬆️
collection 100.00% <ø> (ø)
proxy 66.27% <ø> (ø)
rest 87.37% <ø> (ø)
ws 36.21% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

6 participants