-
Notifications
You must be signed in to change notification settings - Fork 521
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
oss.gg: side quest blog side quest 8, follow the unkey x, starry eyed supporter, create a template [3200 points] #2383
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request includes updates to four documents related to contributions in the "Follow the Unkey X account," "Starry-eyed Supporter," and template submissions for using Unkey with Hapi.js. A new participant, Yash Parmar, is added with specific dates and links to their accounts. Additionally, the last entry in the "Starry-eyed Supporter" document is updated to reflect Yash Parmar as the contributor, along with a new template submission for using Unkey with Hapi.js. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
@Yash-1511 is attempting to deploy a commit to the Unkey Team on Vercel. A member of the Team first needs to authorize it. |
Hey there and thank you for opening this pull request! 👋🏼 We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.
Details:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
oss.gg/3_follow_the_unkey_x_account.md (1)
50-52
: Format the X account link as a clickable linkThe new entry looks good and follows the existing format. However, to improve consistency and address the Markdownlint warning, please format the X account link as a clickable link.
Apply this change to format the link:
» 13-October-2024 by [Yash Parmar](@Yash-1511) -» Link to Account: https://x.com/yashp3020 +» Link to Account: [https://x.com/yashp3020](https://x.com/yashp3020)This change will make the link clickable and resolve the Markdownlint warning about bare URLs.
🧰 Tools
🪛 Markdownlint
51-51: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (3)
- oss.gg/3_follow_the_unkey_x_account.md (1 hunks)
- oss.gg/4_starry_eyed_supporter.md (1 hunks)
- oss.gg/7_create_a_template.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
- oss.gg/4_starry_eyed_supporter.md
🧰 Additional context used
🪛 Markdownlint
oss.gg/3_follow_the_unkey_x_account.md
51-51: null
Bare URL used(MD034, no-bare-urls)
🔇 Additional comments (2)
oss.gg/3_follow_the_unkey_x_account.md (1)
50-52
: LGTM! Verify contributor informationThe new entry for Yash Parmar is consistent with the existing format and contains all the required information. It's also placed in the correct chronological order.
To ensure the accuracy of the information, please run the following script to verify the GitHub username and X account:
This script will help verify that both the GitHub username and X account are valid and accessible.
✅ Verification successful
Contributor information verified
Both GitHub user Yash-1511 and X account yashp3020 have been successfully verified and exist.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify GitHub username and X account # Check if the GitHub user exists gh api users/Yash-1511 > /dev/null 2>&1 if [ $? -eq 0 ]; then echo "GitHub user Yash-1511 exists" else echo "GitHub user Yash-1511 does not exist" fi # Check if the X account exists (Note: This is a basic check and may not be 100% reliable) curl -s -o /dev/null -w "%{http_code}" https://x.com/yashp3020 | grep 200 > /dev/null if [ $? -eq 0 ]; then echo "X account yashp3020 exists" else echo "X account yashp3020 may not exist or is not accessible" fiLength of output: 266
🧰 Tools
🪛 Markdownlint
51-51: null
Bare URL used(MD034, no-bare-urls)
oss.gg/7_create_a_template.md (1)
44-45
: LGTM! Verify license and READMEThe new entry for Yash Parmar's Hapi.js Unkey Boilerplate is correctly formatted and aligns with the PR objectives. It's a unique contribution, not duplicating any existing templates.
Please run the following script to verify the MIT license and README.md requirements:
✅ Verification successful
License and README Verified ✅
The Hapi.js Unkey Boilerplate repository includes an MIT License and a README.md with a Quickstart section as required. All verification checks have passed.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify MIT license and README.md in the Hapi.js Unkey Boilerplate repository # Clone the repository git clone https://github.com/Yash-1511/hapi-unkey-template.git cd hapi-unkey-template # Check for MIT license if grep -q "MIT License" LICENSE; then echo "MIT License found" else echo "MIT License not found" fi # Check for README.md and quickstart section if [ -f README.md ]; then echo "README.md found" if grep -qi "quickstart" README.md; then echo "Quickstart section found in README.md" else echo "Quickstart section not found in README.md" fi else echo "README.md not found" fi # Clean up cd .. rm -rf hapi-unkey-templateLength of output: 484
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
oss.gg/8_use_unkey_blog.md (1)
Line range hint
21-23
: Consider adjusting the template entry date.The new entry maintains the document structure and provides a template for future contributors. However, the date (01-October-2024) is earlier than the previous entry (16-October-2024), which might cause confusion about the chronological order of entries.
Consider one of the following options:
- Adjust the template date to be after the most recent entry, e.g., "DD-Month-2024" or a specific future date.
- Add a comment explaining that the date should be updated by the next contributor.
Example implementation:
-» 01-October-2024 by YOUR NAME +» DD-Month-2024 by YOUR NAME # Update this date when adding your entryoss.gg/3_follow_the_unkey_x_account.md (1)
49-50
: LGTM! Minor formatting suggestion for consistency.The new entry for Yash Parmar is correctly added and follows the required schema. Great job!
For consistency with some other entries, consider enclosing the X account link in angle brackets:
» 13-October-2024 by [Yash Parmar](@Yash-1511) -» Link to Account: https://x.com/yashp3020 +» Link to Account: <https://x.com/yashp3020>🧰 Tools
🪛 Markdownlint
50-50: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (3)
- oss.gg/3_follow_the_unkey_x_account.md (1 hunks)
- oss.gg/7_create_a_template.md (1 hunks)
- oss.gg/8_use_unkey_blog.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- oss.gg/7_create_a_template.md
🧰 Additional context used
🪛 Markdownlint
oss.gg/3_follow_the_unkey_x_account.md
50-50: null
Bare URL used(MD034, no-bare-urls)
53-53: null
Bare URL used(MD034, no-bare-urls)
56-56: null
Bare URL used(MD034, no-bare-urls)
🔇 Additional comments (2)
oss.gg/8_use_unkey_blog.md (1)
19-19
: LGTM! Verify contributor information.The date update and contributor name change are consistent with the PR objectives. The entry format follows the provided schema correctly.
To ensure the accuracy of the contributor information, please run the following script:
✅ Verification successful
Contributor information verified.
The contributor "Yash-1511" exists and is associated with PR #2383, as confirmed by the verification scripts.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the contributor's GitHub username and PR association # Test: Check if the GitHub user exists and is associated with this PR gh api users/Yash-1511 --jq '.login' || echo "User not found" gh pr view 2383 --json author --jq '.author.login'Length of output: 107
oss.gg/3_follow_the_unkey_x_account.md (1)
50-56
: Markdownlint warnings about bare URLs can be ignored.The static analysis tool Markdownlint has flagged bare URLs on lines 50, 53, and 56. However, these warnings can be safely ignored for the following reasons:
- The document specifically requests URLs in this format.
- Changing the URL format would deviate from the intended structure and consistency of the document.
- In this context, bare URLs are more readable and align with the document's purpose.
No action is required to address these warnings.
🧰 Tools
🪛 Markdownlint
50-50: null
Bare URL used(MD034, no-bare-urls)
53-53: null
Bare URL used(MD034, no-bare-urls)
56-56: null
Bare URL used(MD034, no-bare-urls)
@Yash-1511 could you update your template to use the new way of checking keys https://github.com/Yash-1511/hapi-unkey-template/blob/c1fbd1a6b9773df1d736cac660f8e45b8098a69e/server.js#L48 const { result, error } = await verifyKey({ key: "key_123", apiId: "api_123" }); |
Hey @chronark , I have updated verifykey with apiId. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
oss.gg/3_follow_the_unkey_x_account.md (1)
50-50
: Consider enclosing the URL in angle brackets.To address the Markdownlint warning and improve consistency with some other entries in the list, consider enclosing the X account URL in angle brackets.
Here's the suggested change:
-» Link to Account: https://x.com/yashp3020 +» Link to Account: <https://x.com/yashp3020>🧰 Tools
🪛 Markdownlint
50-50: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- oss.gg/3_follow_the_unkey_x_account.md (2 hunks)
- oss.gg/4_starry_eyed_supporter.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- oss.gg/4_starry_eyed_supporter.md
🧰 Additional context used
🪛 Markdownlint
oss.gg/3_follow_the_unkey_x_account.md
50-50: null
Bare URL used(MD034, no-bare-urls)
🔇 Additional comments (1)
oss.gg/3_follow_the_unkey_x_account.md (1)
49-51
: LGTM! New entry added correctly.The new entry for Yash Parmar has been added following the existing format and maintains the chronological order of the list. This is consistent with the document's structure and the PR objectives.
🧰 Tools
🪛 Markdownlint
50-50: null
Bare URL used(MD034, no-bare-urls)
It looks like https://github.com/FelixCoder308 was created just to star the oss.gg repositories, that's against the rules |
Actually, the account wasn't created just for starring those repositories. My friend started freelancing around 3-4 months ago, which is when they created this GitHub account. While there may not be many public repositories, there are some private ones. You can verify this by checking the API at the link provided: Also, could you please share the rulebook or guidelines you're referring to? I'd like to review the specific rules you're mentioning. |
/award 3200 |
Awarding Yash-1511: 3200 points 🕹️ Well done! Check out your new contribution on oss.gg/Yash-1511 |
Description
Completed the challenge of side quest Follow on X, created a template that uses unkey api to protect and gathering five friends to star the repository.
https://github.com/Yash-1511/hapi-unkey-template
https://github.com/Yash-1511/hono-unkey-deno
Write a blog about unkey api that i use in our application [1500 points]
https://medium.com/@yashp3020/how-i-secured-my-ai-powered-legal-compliance-api-with-unkey-a9df815209b2
follow on X screenshot[50 points]
GitHub Usernames of Friends [150 Points]
Screenshots
@virugamacoder
@harshp421
@Felixcoder308
@nandani-1411
@gtlYashParmar
Summary by CodeRabbit
Summary by CodeRabbit
New Features
Updates