Feature Request: Designing a new stat card for showing GitHub streak

yaten2302 commented 1 year ago

Is your feature request related to a problem? Please describe.

The GRS has a lot of stats cards included, but there is no card for showing the streak of the user.

Describe the solution you'd like

My solution to this issue:

Creating a new stat card for showing the total contributions, current streak and the longest streak of the user(along with date) I'll also share the sample template that how the stat card will look like, once this issue gets approved.

Describe alternatives you've considered

No response

Additional context

No response

yaten2302 commented 1 year ago

Hi @rickstaa, @qwerty541, I just took an idea from a website that how to design the streak card. The card will not be exactly the same, but will change the layout a couple of things, may I create a PR, if you approve?

qwerty541 commented 1 year ago

Hi, @yaten2302! Thanks for your feature request! The following repository already provides such card https://github.com/DenverCoder1/github-readme-streak-stats. I have nothing against having streak stats card in this project, but on condition that this card will have unique design, significatly different from the one you provided. I don't see the point in two different projects providing the same card.

yaten2302 commented 1 year ago

Hi, @yaten2302! Thanks for your feature request! The following repository already provides such card https://github.com/DenverCoder1/github-readme-streak-stats. I have nothing against having streak stats card in this project, but on condition that this card will have unique design, significatly different from the one you provided. I don't see the point in two different projects providing the same card.

Yeah😅, actually, this project is made using php, so that's why I thought of creating this issue, since it's in JavaScript. If not required may I close this issue?

qwerty541 commented 1 year ago

Hi, @yaten2302! Thanks for your feature request! The following repository already provides such card https://github.com/DenverCoder1/github-readme-streak-stats. I have nothing against having streak stats card in this project, but on condition that this card will have unique design, significatly different from the one you provided. I don't see the point in two different projects providing the same card.

Yeah😅, actually, this project is made using php, so that's why I thought of creating this issue, since it's in JavaScript. If not required may I close this issue?

Having a streak stats card may be a good feature for this project, we can keep this issue open if you or anyone else are up to create unique design. If you do not want to do this feel free to close.

yaten2302 commented 1 year ago

Yeah sure😃, I would love to work on this issue, will try to make a better design and then will send it here for more modifications and improvements 👍

rickstaa commented 1 year ago

Hi, @yaten2302! Thanks for your feature request! The following repository already provides such card https://github.com/DenverCoder1/github-readme-streak-stats. I have nothing against having streak stats card in this project, but on condition that this card will have unique design, significatly different from the one you provided. I don't see the point in two different projects providing the same card.

Yeah😅, actually, this project is made using php, so that's why I thought of creating this issue, since it's in JavaScript. If not required may I close this issue?

Having a streak stats card may be a good feature for this project, we can keep this issue open if you or anyone else are up to create unique design. If you do not want to do this, feel free to close.

@yaten2302, thanks for wanting to contribute to GRS. Providing users with a streak card is logical. Since it is a good design, I am okay with the card being close to https://github.com/DenverCoder1/github-readme-streak-stats. But I agree with @qwerty541 that having a unique design would make it less redundant 👍🏻.

yaten2302 commented 1 year ago

This is how the card will look like. It will be great if someone wants to suggest some modifications or improvements in it. Alternatively the days will be added in place of weeks, as per the user's requirements.

yaten2302 commented 1 year ago

This is how the card will look like. It will be great if someone wants to suggest some modifications or improvements in it. Alternatively the days will be added in place of weeks, as per the user's requirements.

Hi @rickstaa , @qwerty541 is this design looking good or should I make some changes in it?

qwerty541 commented 1 year ago

This is how the card will look like. It will be great if someone wants to suggest some modifications or improvements in it. Alternatively the days will be added in place of weeks, as per the user's requirements.

Hi @rickstaa , @qwerty541 is this design looking good or should I make some changes in it?

Hi, @yaten2302. Looks the same as our stats card, nothing special, but I think it will suit us. But I would have written "Person's streak stats" instead of "Person's streak info". Also I wouldn't make the title in italics. I also hope that you understand that this card should support all our themes as well as other cards and this blue coloring is only for example, by default the card should be displayed in the standard GItHub theme.

yaten2302 commented 1 year ago

This is how the card will look like. It will be great if someone wants to suggest some modifications or improvements in it. Alternatively the days will be added in place of weeks, as per the user's requirements.

Hi @rickstaa , @qwerty541 is this design looking good or should I make some changes in it?

Hi, @yaten2302. Looks the same as our stats card, nothing special, but I think it will suit us. But I would have written "Person's streak stats" instead of "Person's streak info". Also I wouldn't make the title in italics. I also hope that you understand that this card should support all our themes as well as other cards and this blue coloring is only for example, by default the card should be displayed in the standard GItHub theme.

Sure, I'll change the heading to "Person's streak stats" and remove the italics. Yes, this theme is just for example, all the themes will be made available for the user and the default will also be set to standard GitHub theme.

qwerty541 commented 1 year ago

This is how the card will look like. It will be great if someone wants to suggest some modifications or improvements in it. Alternatively the days will be added in place of weeks, as per the user's requirements.

Hi @rickstaa , @qwerty541 is this design looking good or should I make some changes in it?

Hi, @yaten2302. Looks the same as our stats card, nothing special, but I think it will suit us. But I would have written "Person's streak stats" instead of "Person's streak info". Also I wouldn't make the title in italics. I also hope that you understand that this card should support all our themes as well as other cards and this blue coloring is only for example, by default the card should be displayed in the standard GItHub theme.

Sure, I'll change the heading to "Person's streak stats" and remove the italics. Yes, this theme is just for example, all the themes will be made available for the user and the default will also be set to standard GitHub theme.

Nice, let's wait also for @rickstaa's thoughts about this.

idkbharti commented 1 year ago

Screenshot 2023-09-23 201127 How about this ?

yaten2302 commented 11 months ago

Hi @rickstaa, @qwerty541
I've created the PR for Streaks Card
Could you please review and merge it.

Also could you please add the hacktoberfest label to this issue.

rickstaa commented 11 months ago

I am closing this since the core team decided that adding this card is currently not the best thing to do. For more information see https://github.com/anuraghazra/github-readme-stats/pull/3338#issuecomment-1762966088.

anuraghazra / github-readme-stats