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: Update 7_create_a_template.md #2517

Closed
wants to merge 1 commit into from

Conversation

utkarshml
Copy link

@utkarshml utkarshml commented Oct 20, 2024

integrate Unkey on symfony framework to protect your API routes.

What does this PR do?

This Symfony template demonstrates how to integrate Unkey to protect API routes.

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Test A
  • Test B

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features
    • Added a new project entry showcasing "Unkey on Symfony Framework (PHP)" by Utkarsh Jaiswal, including a link to the GitHub repository.
  • Documentation
    • Updated project list to include the new entry while maintaining existing submission guidelines.

integrate Unkey on symfony framework to protect your API routes.
Copy link

changeset-bot bot commented Oct 20, 2024

⚠️ No Changeset found

Latest commit: bdf1ebb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

vercel bot commented Oct 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 20, 2024 4:29pm

Copy link

vercel bot commented Oct 20, 2024

@utkarshml is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Oct 20, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a new entry to a project list showcasing the use of Unkey with various frameworks. It adds a contribution by Utkarsh Jaiswal titled "Unkey on Symfony Framework (PHP)" along with a link to the corresponding GitHub repository. The submission date is noted as 19-October-2024. The overall structure and submission requirements remain unchanged, emphasizing the need for open-source projects, MIT licensing, and inclusion of a README.md with a quickstart guide.

Changes

File Change Summary
oss.gg/7_create_a_template.md Added new entry: Author - Utkarsh Jaiswal, Title - "Unkey on Symfony Framework (PHP)", Repository - GitHub link, Date - 19-October-2024.

Possibly related PRs

Suggested labels

🕹️ oss.gg, :joystick: 750 points

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr
  • MichaelUnkey

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 39b236f and bdf1ebb.

📒 Files selected for processing (1)
  • oss.gg/7_create_a_template.md (1 hunks)
🧰 Additional context used
🔇 Additional comments (2)
oss.gg/7_create_a_template.md (2)

57-57: LGTM! New entry follows the required format.

The new entry for Utkarsh Jaiswal's Symfony Framework template is correctly formatted and appears to be a unique contribution to the list.


57-57: Verify repository contents and link accessibility.

While the entry format is correct, please ensure that the linked repository meets all the requirements:

  1. The project should be open source.
  2. It should be MIT licensed.
  3. It must include a README.md with a quickstart guide.

Additionally, we need to verify that the link is accessible.

Run the following script to verify the repository contents and link accessibility:

✅ Verification successful

Repository verified successfully.

All requirements are met:

  • The repository is accessible.
  • It is MIT licensed.
  • It includes a README.md with an Installation section serving as a quickstart guide.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify repository contents and link accessibility

# Test 1: Check if the link is accessible
echo "Checking link accessibility..."
curl -I https://github.com/utkarshml/unkey_symfony

# Test 2: Check for README.md file
echo "Checking for README.md..."
curl -s https://api.github.com/repos/utkarshml/unkey_symfony/contents | jq '.[] | select(.name == "README.md") | .name'

# Test 3: Check for LICENSE file (assuming MIT license)
echo "Checking for LICENSE file..."
curl -s https://api.github.com/repos/utkarshml/unkey_symfony/license | jq '.license.spdx_id'

Length of output: 5422


Script:

#!/bin/bash
# Description: Verify that README.md includes a quickstart guide

echo "Checking for quickstart guide in README.md..."
curl -s https://raw.githubusercontent.com/utkarshml/unkey_symfony/main/README.md | grep -iE "quickstart|getting started|installation|setup"

Length of output: 258


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

github-actions bot commented Oct 20, 2024

Thank you for following the naming conventions for pull request titles! 🙏

@chronark
Copy link
Collaborator

please add instructions how to create the resources in unkey to your readme

@chronark
Copy link
Collaborator

/award 750

@chronark chronark closed this Oct 29, 2024
Copy link

oss-gg bot commented Oct 29, 2024

Awarding utkarshml: 750 points 🕹️ Well done! Check out your new contribution on oss.gg/utkarshml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants