denvercoder1 / github-readme-youtube-stats Goto Github PK

Issue

When validating the ID parameter, hyphens and underscores are considered not valid making it give the wrong channel info.

Some channel IDs, such as UC-lHJZR3Gqxm24_Vd_AJ5Yw, contain hyphens and underscores and should be allowed.

You will need to modify the regex for validating the ID to allow underscores and hyphens.

Leave a comment if you plan on fixing this

Issue

The YouTube Data API stores numbers without commas. When creating the badge, Shields.io handles the creation of the badge from the point of passing the URL onward. The task of this issue is to ensure that commas will get added to the badge that is generated.

Two different approaches

One way you could approach this problem is by implementing the YouTube Data API calls within the PHP code, add commas to the resulting number (for example, using number_format()). Use the retrieved information to make a "static" Shields.io badge.

The second approach would be to run a replacement on the string returned by the curl_get_contents() function.

Whichever method of implementing the feature you choose is fine.

Expected outcome

Before implementing the change:

After implementing the change:

Issue

The for-the-badge style should use uppercase letters for the label and message.

What it currently does

The k is lowercase:

What it should do

The k should be capitalized:

Other styles should continue to use lowercase letters:

Please comment on the issue before making a pull request.

This issue is for first-timers only! Since this a simple issue to fix, I am offering this issue specifically to those who have submitted fewer than 4 pull requests

Issue

With #4 and #5, a new url parameter was introduced call format.

See the relevant issues for the details of what this parameter does and what the options are.

There is not yet a section in the README explaining how to use it.

Following the style of other parameter explanations, the documentation for this new parameter should be added.

Please comment on the issue before making a pull request.

This issue is for first-timers only! Since this a simple issue to fix, I am offering this issue specifically to those who have submitted fewer than 4 pull requests

PHP code is more manageable when return types are declared.

To fix this issue, make a pull request with the return type specified for each function.

Reference: https://www.tutorialspoint.com/php7/php7_returntype_declarations.htm

This issue is for first-timers only! Since this a simple issue to fix, I am offering this issue specifically to those who have submitted fewer than 4 pull requests

Issue

Currently, the number is updated with a regex replacement on the response from Shields.io. The rectangle width and text length don't get updated, causing the text to occasionally appear stretched like shown here:

Potential fixes

The easiest fix might be to be to fetch the YouTube statistics before creating the shields.io URL and use the static shields.io API instead of dynamic. Doing it this way will allow shields.io to determine what the rectangle size and text length should be.

The format for the static shields.io URLs is like this:

https://img.shields.io/static/v1?label=<LABEL>&message=<MESSAGE>&color=<COLOR>

Other query parameters such as labelColor, style, and others will still work.

Steps

• Fetch the data from the YouTube API with curl_get_contents and json_decode
• Locate the view count and subscriber count numbers using array indexing
• Set the message parameter to the number, but make sure the number is in the right format first
• Remove unused code

If you are able to accurately resize the input another way, feel free to do it as you choose.

If you have any questions, don't hesitate to ask!

Please comment on the issue before making a pull request.

This issue is for first-timers only! Since this a simple issue to fix, I am offering this issue specifically to those who have submitted fewer than 4 pull requests

Add an optional url parameter called format which will allow users to select between 3 formats of numbers:

• format=none

• format=commas

• format=short

Commas is already implemented by #2.

Issues

• Implement a short numbers function to convert numbers to a rounded form (ex. 3.5k, 6.8m, 9.1b)

Suggested reference: https://stackoverflow.com/a/52490452/11608064

• Implement a url parameter to allow choosing between different number formats (ex. format=commas, format=short)

• If the parameter is not specified, the default value that should be used is short

This issue is for first-timers only! Since this a simple issue to fix, I am offering this issue specifically to those who have submitted fewer than 4 pull requests