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: add GitHub star history #312

Closed

Conversation

trueNAHO
Copy link
Collaborator

@trueNAHO trueNAHO commented Mar 30, 2024

Add the GitHub star history to illustrate the project's popularity and enhance its chances of wider adoption.

Reference:

Here is what the illustration looks like:

Star History Chart

@trueNAHO trueNAHO force-pushed the docs-readme-add-github-star-history branch 2 times, most recently from 3eb83e5 to 97ffc0a Compare March 30, 2024 11:48
Add the GitHub star history to illustrate the project's popularity and
enhance its chances of wider adoption.

Reference:

- trueNAHO/dotfiles@44fbb60
@trueNAHO trueNAHO force-pushed the docs-readme-add-github-star-history branch from 97ffc0a to cdba91f Compare March 30, 2024 11:49
@trueNAHO trueNAHO marked this pull request as ready for review March 30, 2024 11:51
Copy link
Owner

@danth danth left a comment

Choose a reason for hiding this comment

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

Note that this also appears in the documentation, where the color scheme doesn't perfectly match.

image

Is there a transparent version of the image (possibly from another service) which we can use?

@trueNAHO
Copy link
Collaborator Author

trueNAHO commented Apr 2, 2024

this also appears in the documentation, where the color scheme doesn't perfectly match.

The default background color seems to be #0d1117.

Is there a transparent version of the image (possibly from another service) which we can use?

Apparently, such an option exists, but I cannot figure out how to use.

@trueNAHO trueNAHO marked this pull request as draft April 9, 2024 19:30
@trueNAHO trueNAHO added the good first issue Good for newcomers label Apr 22, 2024
@pyrox0
Copy link

pyrox0 commented Apr 23, 2024

So, I know this isn't my project, and far be it from me to say how a project should advertise itself, but why? What use does this serve? How does it "enhance its chances of wider adoption", as you say? This doesn't seem to be useful. Yes, large projects use it, but correlation does not equal causation. If anything, I would say that star history graphs are used by large projects to show that they are popular, but don't help when a project is small(not that I think they help anyways)

@jalil-salame
Copy link
Contributor

Is there a transparent version of the image (possibly from another service) which we can use?

Apparently, such an option exists, but I cannot figure out how to use.

Isn't it adding &transparent=true to the end of the URL.

Also, the URL looks weird:

// Upstream example
https://api.star-history.com/svg?repos=star-history/star-history&type=Date&theme=dark

// This PR
https://api.star-history.com/svg?repos=danth/stylix&theme=dark

// Expected URL
https://api.star-history.com/svg?repos=danth/stylix&theme=dark&transparent=true

@danth
Copy link
Owner

danth commented Apr 23, 2024

How does it "enhance its chances of wider adoption", as you say?

Presumably by showing the star count and how it has gradually increased over time, which demonstrates the longevity of the project.

Although they can be useful in some aspects, I would agree that a star chart could make it feel like the project exists for the primary purpose of gaining popularity, rather than providing code.

Also, the URL looks weird

This is HTML embedded in a Markdown document. As described in the HTML specification:

Authors should use & (ASCII decimal 38) instead of & to avoid confusion with the beginning of a character reference (entity reference open delimiter). Authors should also use & in attribute values since character references are allowed within CDATA attribute values.

@trueNAHO
Copy link
Collaborator Author

So, I know this isn't my project, and far be it from me to say how a project should advertise itself, but why? What use does this serve? How does it "enhance its chances of wider adoption", as you say? This doesn't seem to be useful. Yes, large projects use it, but correlation does not equal causation. If anything, I would say that star history graphs are used by large projects to show that they are popular, but don't help when a project is small(not that I think they help anyways)

How does it "enhance its chances of wider adoption", as you say?

Presumably by showing the star count and how it has gradually increased over time, which demonstrates the longevity of the project.

Although they can be useful in some aspects, I would agree that a star chart could make it feel like the project exists for the primary purpose of gaining popularity, rather than providing code.

Thanks for all the insightful comments. Frankly, I had not considered these popularity advertisement implications.

Upon discovering this tool, I simply thought it is interesting to see that the popularity of most popular projects increases exponentially rather than linearly:

Star History Chart

This information might be more relevant in a pitch rather than the project itself. Feel free to close this PR.

@trueNAHO
Copy link
Collaborator Author

Is there a transparent version of the image (possibly from another service) which we can use?

Apparently, such an option exists, but I cannot figure out how to use.

Isn't it adding &transparent=true to the end of the URL.

IIRC, that did not work last time I tried it, although I may have used it incorrectly.

@trueNAHO
Copy link
Collaborator Author

So, I know this isn't my project, and far be it from me to say how a project should advertise itself, but why? What use does this serve? How does it "enhance its chances of wider adoption", as you say? This doesn't seem to be useful. Yes, large projects use it, but correlation does not equal causation. If anything, I would say that star history graphs are used by large projects to show that they are popular, but don't help when a project is small(not that I think they help anyways)

How does it "enhance its chances of wider adoption", as you say?

Presumably by showing the star count and how it has gradually increased over time, which demonstrates the longevity of the project.
Although they can be useful in some aspects, I would agree that a star chart could make it feel like the project exists for the primary purpose of gaining popularity, rather than providing code.

Thanks for all the insightful comments. Frankly, I had not considered these popularity advertisement implications.

The "Factors contributing to daily stars" section might be interesting.

trueNAHO added a commit to trueNAHO/dotfiles that referenced this pull request May 20, 2024
Remove the GitHub star history based on the "Design by Subtraction"
principle, as coined by Ueda Fumito.

Related:

- 44fbb60
- 66f4c5d
- danth/stylix#312
@trueNAHO
Copy link
Collaborator Author

Closing this PR based on #312 (comment).

@trueNAHO trueNAHO closed this May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants