From 9daada2c68fac04465ae2059e8762e49814d9b4b Mon Sep 17 00:00:00 2001 From: chronark Date: Mon, 30 Sep 2024 11:28:52 +0200 Subject: [PATCH] chore: oss.gg examples --- oss.gg/1_bug_hunter.md | 4 ++++ oss.gg/2_accessibility_advocate.md | 3 +++ oss.gg/3_follow_the_unkey_x_account.md | 2 ++ oss.gg/4_starry_eyed_supporter.md | 3 +++ oss.gg/5_enhance_docs.md | 4 ++++ oss.gg/6_record_onboarding.md | 3 +++ oss.gg/7_create_a_template.md | 3 +++ oss.gg/8_use_unkey_blog.md | 3 +++ 8 files changed, 25 insertions(+) diff --git a/oss.gg/1_bug_hunter.md b/oss.gg/1_bug_hunter.md index a73a557e84..1195b84163 100644 --- a/oss.gg/1_bug_hunter.md +++ b/oss.gg/1_bug_hunter.md @@ -1,5 +1,9 @@ **Side Quest**: Bug Hunter + Find and report any bug in our core product, api or on app.unkey.com + **Points**: 50 - 150 points for every bug + **Proof**: Open a complete bug issue in our repository incl. screen shots if relevant. + diff --git a/oss.gg/2_accessibility_advocate.md b/oss.gg/2_accessibility_advocate.md index b97d691891..8858ae1b52 100644 --- a/oss.gg/2_accessibility_advocate.md +++ b/oss.gg/2_accessibility_advocate.md @@ -1,4 +1,7 @@ **Side Quest**: Accessibility Advocate + Conduct an accessibility audit of app.unkey.com and provide recommendations for improvements. Only new findings count, don’t copy from others ⚠️ + **Points**: 50 - 300 points depending on the severity + **Proof**: Open a bug issue in our repository incl. screen shots if relevant. diff --git a/oss.gg/3_follow_the_unkey_x_account.md b/oss.gg/3_follow_the_unkey_x_account.md index 37b5c3d93e..895c220cc7 100644 --- a/oss.gg/3_follow_the_unkey_x_account.md +++ b/oss.gg/3_follow_the_unkey_x_account.md @@ -1,5 +1,7 @@ **Side Quest**: Follow the Unkey X account + **Points**: 50 Points + **Proof**: Open a PR with your X account handle and screenshot. Add a link to your X account in the list below. Please follow the following schema: diff --git a/oss.gg/4_starry_eyed_supporter.md b/oss.gg/4_starry_eyed_supporter.md index 8e1bbec165..5734882094 100644 --- a/oss.gg/4_starry_eyed_supporter.md +++ b/oss.gg/4_starry_eyed_supporter.md @@ -1,6 +1,9 @@ **Side Quest**: Starry-eyed Supporter + Get five friends to star our repository. + **Points**: 150 Points + **Proof**: Open a PR with sufficient screenshots to prove that you asked them and they confirmed + their GitHub names. Please follow the following schema: diff --git a/oss.gg/5_enhance_docs.md b/oss.gg/5_enhance_docs.md index c78a84958e..7af176653d 100644 --- a/oss.gg/5_enhance_docs.md +++ b/oss.gg/5_enhance_docs.md @@ -1,4 +1,8 @@ + **Side Quest**: Enhance Docs + Add a new section to our docs where you see gaps. Dependending on the added value, we will assign points. Make sure to follow the current style of documentation incl. code snippets and screenshots. + **Points**: 50 - 300 points + **Proof**: Open a PR with "Docs" in the title diff --git a/oss.gg/6_record_onboarding.md b/oss.gg/6_record_onboarding.md index 530221371d..635b7818a2 100644 --- a/oss.gg/6_record_onboarding.md +++ b/oss.gg/6_record_onboarding.md @@ -1,4 +1,5 @@ **Side Quest**: Record your onboarding and first steps wit Unkey + Record yourself going through the setup of Unkey for the first time and provide feedback. Depending on how much feedback you provide, we’ll assign 150 or 300 points. You do not need to show your face if you don’t want to but voice is required. Please say out loud what you’re thinking or expecting as you go. @@ -8,7 +9,9 @@ What should be included: - Integrating Unkey into your app and either verify a key or use the ratelimiter If you get stuck and can not do all of them, please report that. That’s probably the best feedback you can provide. + **Points**: 150 - 300 points + **Proof**: Open a PR with a link to your video (youtube, loom, google drive…), if you have more feedback that is not mentioned in the video, please add it in the PR as well. Please follow the following schema: diff --git a/oss.gg/7_create_a_template.md b/oss.gg/7_create_a_template.md index ae9d8b4156..0740b840b1 100644 --- a/oss.gg/7_create_a_template.md +++ b/oss.gg/7_create_a_template.md @@ -1,4 +1,5 @@ **Side Quest**: Create a template of using some framework or language to build an API and protect it with Unkey + Record yourself going through the setup of Unkey for the first time and provide feedback. Depending on how much feedback you provide, we’ll assign 150 or 300 points. Create a minimal starter template to showcase how you can use Unkey with a particular framework. For example [Ratelimit your Next.js routes](https://www.unkey.com/templates/ratelimit-nextjs) or [Middleware for golang’s echo framework](https://www.unkey.com/templates/echo-middleware). Requirements: @@ -6,7 +7,9 @@ Requirements: - Must be open source, either committed to [github.com/unkeyed/examples](https://github.com/unkeyed/examples) or to your own GitHub account. - Must be MIT licensed - Must have a README.md including a quickstart for how to run your example. + **Points**: 150 - 300 points + **Proof**: Open a PR including the link to your repository. Please follow the following schema: diff --git a/oss.gg/8_use_unkey_blog.md b/oss.gg/8_use_unkey_blog.md index 54c3e84ee5..319bb03aa5 100644 --- a/oss.gg/8_use_unkey_blog.md +++ b/oss.gg/8_use_unkey_blog.md @@ -1,6 +1,9 @@ **Side Quest**: Use Unkey in your app and write a blog post about it + [Protect your API](https://www.unkey.com/docs/apis/introduction) with Unkey or use our [ratelimiter](https://www.unkey.com/docs/ratelimiting/introduction) for your user-triggered actions in your application. Then write a technical blog post about the process and outcome, including code snippets and a link back to [unkey.com](https://unkey.com). + **Points**: 1500 Points + **Proof**: Open a PR including the link to your application and blog post. Please follow the following schema: