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: add usage trend #3374

Open
wants to merge 2 commits into
base: next
Choose a base branch
from
Open

chore: add usage trend #3374

wants to merge 2 commits into from

Conversation

cwtuan
Copy link

@cwtuan cwtuan commented Jan 18, 2025

Hi, I’d like to suggest adding a dynamic NPM downloads trend image to the README of faker-js. This image would visually highlight the growth in popularity of the package over the past 3 years, helping new users see that the package is actively maintained and gaining popularity.

As a maintainer of npm-compare.com, a platform offering insights into NPM package trends, I believe this PR could give potential users more confidence in adopting faker-js for their projects. It provides a clear and real-time view of the package's increasing usage.

If there are any additional features from npm-compare.com that could further benefit the faker-js project, I’d be more than happy to implement them as well.

Thank you for considering my suggestion. I look forward to your feedback and the opportunity to contribute to this awesome project!

@cwtuan cwtuan requested a review from a team as a code owner January 18, 2025 12:38
Copy link

netlify bot commented Jan 18, 2025

Deploy Preview for fakerjs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit f23d72b
🔍 Latest deploy log https://app.netlify.com/sites/fakerjs/deploys/678e08b8e16d8500085fb2c7
😎 Deploy Preview https://deploy-preview-3374.fakerjs.dev
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ST-DDT ST-DDT added this to the vAnytime milestone Jan 18, 2025
@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Jan 18, 2025
Copy link

codecov bot commented Jan 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.97%. Comparing base (192b540) to head (f23d72b).

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #3374   +/-   ##
=======================================
  Coverage   99.97%   99.97%           
=======================================
  Files        2811     2811           
  Lines      217035   217035           
  Branches      940      941    +1     
=======================================
  Hits       216982   216982           
  Misses         53       53           

@xDivisionByZerox
Copy link
Member

xDivisionByZerox commented Jan 20, 2025

Thank you for your contribution! The addition of the usage trend feature is a good idea to provide insights into the popularity of the package. However, I have a few points for discussion:

  1. The first thing I noticed was the sheer size of the embedded image. We already have several badges at the top of the README for tracking and providing various stats. Such a large image feels out of place and overwhelms the user, in my opinion.
  2. Related to the previous point: I'm not sure if the README file is the best place for this information. It might be helpful on npmjs.com, although they themself already provides these information on the sidebar. We identified that users looking at the README on GitHub are usually already interested and want a quick overview of the potential solutions this package provides or how the API is used. I could see such a statistic being relevant or at least nice addition to our documentation, perhaps to fill the more or less empty roadmap page?
  3. Can you tell me for how long you have been having the website? I've heard of similar websites like npmtrends or npm-stat before. I've never heard of your website. This is not meant to be an insult but like you are saying in your own argument: seeing the way a service is addopted by the community has direct influence on the decision of others thinking whether to adapt as well.
  4. One more thing: I noticed that your website does not seem to be GDPR compliant since you are using Google Analytics without an explicit opt-in mechanism.

Please let me know what you think about my concerns.

@ST-DDT
Copy link
Member

ST-DDT commented Jan 21, 2025

Do you have a GitHub repo/issue tracker as well?
I would like to provide some feedback.

@matthewmayer
Copy link
Contributor

If this is not an official NPM project i think you are supposed to request permission from npm, Inc first to use "npm" in your product name.

https://docs.npmjs.com/policies/logos-and-usage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants