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

feat: Create a template with Unkey #2272

Merged
merged 2 commits into from
Oct 8, 2024
Merged

feat: Create a template with Unkey #2272

merged 2 commits into from
Oct 8, 2024

Conversation

Ionfinisher
Copy link
Contributor

@Ionfinisher Ionfinisher commented Oct 8, 2024

What does this PR do?

Add entry for create template for unkey

Fixes #2150

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

Summary by CodeRabbit

  • New Features

    • Introduced a new side quest for creating templates using the Unkey framework to build APIs.
    • Expanded contribution section with new projects showcasing Unkey's integration with various frameworks.
  • Documentation

    • Updated submission requirements to include originality, open-source licensing, and README.md inclusion.

Copy link

changeset-bot bot commented Oct 8, 2024

⚠️ No Changeset found

Latest commit: 574ced6

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

Copy link

vercel bot commented Oct 8, 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 8, 2024 4:20am

Copy link

vercel bot commented Oct 8, 2024

@Ionfinisher 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 8, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a new side quest focused on creating templates for building APIs using the Unkey framework. It outlines submission requirements, including originality, open-source licensing, and the inclusion of a README.md file. Additionally, the contributions section has been updated with new entries showcasing various projects that utilize Unkey across different frameworks, including Flask, Django, and Rust.

Changes

Files Change Summary
oss.gg/7_create_a_template.md - Added a new side quest for creating API templates with Unkey.
- Specified submission requirements: originality, open-source licensing (MIT), and README.md.
- Expanded contributions section with new projects by Harsh Bhat, Nazar Poshtarenko, and Teddy ASSIH.

Assessment against linked issues

Objective Addressed Explanation
Add new side quests for API template creation (#2150)
Outline submission requirements for side quests (#2150)
Update contributions section with new projects (#2150)

Possibly related PRs

Suggested labels

🕹️ oss.gg, :joystick: 750 points, hacktoberfest

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 2051528 and 574ced6.

📒 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)

Line range hint 1-35: LGTM: Well-structured content with clear instructions

The overall structure and content of the file are well-organized and aligned with the PR objectives. The side quest description, requirements, and contribution format are clearly presented, making it easy for participants to understand and contribute.


36-36: LGTM: New contribution adheres to format and requirements

The new contribution by Teddy ASSIH follows the established format and aligns with the side quest objectives. It provides a template for using Unkey with Django Rest Framework, which is a valuable addition to the existing contributions.

To ensure the contribution meets all requirements, please run the following script:


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 8, 2024

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

@chronark chronark merged commit 6985f7e into unkeyed:main Oct 8, 2024
5 of 9 checks passed
Copy link

oss-gg bot commented Oct 8, 2024

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

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

Successfully merging this pull request may close these issues.

[🕹️] SIDE QUESTS: https://go.unkey.com/ossgg-challenges
2 participants