feat: added contributors (#206)

* feat: added contributors * doc: fix contributors section * style: fmt * chore: update description --------- Co-authored-by: amit <[email protected]>
tailcallhq · Apr 13, 2024 · c3a7f3f · c3a7f3f
1 parent 5f6afa4
commit c3a7f3f
Show file tree

Hide file tree

Showing 10 changed files with 575 additions and 98 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml
@@ -1,53 +1,53 @@
-name: Bug report
-description: Create a bug report to help us improve Tailcall
-title: "[bug]: "
-labels: [bug]
-body:
-- type: markdown
-  attributes:
-    value: |
-      Thank you for taking the time to fill out this bug report.
-- type: checkboxes
-  attributes:
-    label: Is there an existing issue for this?
-    description: Please search to see if an issue already exists for the bug you encountered
-    options:
-    - label: I have searched the existing issues
-      required: true
-- type: textarea
-  attributes:
-    label: Current behavior
-    description: A concise description of what you're experiencing and what you expect
-    placeholder: |
-      When I do <X>, <Y> happens and I see the error message attached below:
-      ```...```
-      What I expect is <Z>
-  validations:
-    required: true
-- type: textarea
-  attributes:
-    label: Steps to reproduce
-    description: Add steps to reproduce this behaviour, include console or network logs and screenshots
-    placeholder: |
-      1. Go to '...'
-      2. Click on '....'
-      3. Scroll down to '....'
-      4. See error
-  validations:
-    required: true
-
-- type: dropdown
-  id: repository
-  attributes:
-    label: Repository
-    options:
-        - tailcall
-        - tailcallhq.github.io
-        - homebrew-tailcall
-        - tailcall-on-aws
-  validations:
-    required: true
-- type: markdown
-  attributes:
-    value: |
-      Please add the respective Label to the Issue
+name: Bug report
+description: Create a bug report to help us improve Tailcall
+title: "[bug]: "
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to fill out this bug report.
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: textarea
+    attributes:
+      label: Current behavior
+      description: A concise description of what you're experiencing and what you expect
+      placeholder: |
+        When I do <X>, <Y> happens and I see the error message attached below:
+        ```...```
+        What I expect is <Z>
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: Add steps to reproduce this behaviour, include console or network logs and screenshots
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+
+  - type: dropdown
+    id: repository
+    attributes:
+      label: Repository
+      options:
+        - tailcall
+        - tailcallhq.github.io
+        - homebrew-tailcall
+        - tailcall-on-aws
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        Please add the respective Label to the Issue
diff --git a/.github/ISSUE_TEMPLATE/documentation-update.yaml b/.github/ISSUE_TEMPLATE/documentation-update.yaml
@@ -29,4 +29,4 @@ body:
   - type: markdown
     attributes:
       value: |
-        Please add the respective Label to the Issue
+        Please add the respective Label to the Issue
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml
@@ -1,43 +1,43 @@
-name: Feature request
-description: Suggest a feature to improve Tailcall
-title: "[feature]: "
-labels: [Enhancement]
-body:
-- type: markdown
-  attributes:
-    value: |
-      Thank you for taking the time to request a feature for Tailcall
-- type: checkboxes
-  attributes:
-    label: Is there an existing feature request for this?
-    description: Please search to see if an issue related to this feature request/feature request already exists
-    options:
-    - label: I have searched the existing issues
-      required: true
-- type: textarea
-  attributes:
-    label: Summary
-    description: One paragraph description of the feature
-  validations:
-    required: true
-- type: textarea
-  attributes:
-    label: Why should this be worked on?
-    description: A concise description of the problems or use cases for this feature request
-  validations:
-    required: true
-- type: dropdown
-  id: repository
-  attributes:
-    label: Repository
-    options:
-        - tailcall
-        - tailcallhq.github.io
-        - homebrew-tailcall
-        - tailcall-on-aws
-  validations:
-    required: true
-- type: markdown
-  attributes:
-    value: |
-      Please add the respective Label to the Issue
+name: Feature request
+description: Suggest a feature to improve Tailcall
+title: "[feature]: "
+labels: [Enhancement]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to request a feature for Tailcall
+  - type: checkboxes
+    attributes:
+      label: Is there an existing feature request for this?
+      description: Please search to see if an issue related to this feature request/feature request already exists
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: textarea
+    attributes:
+      label: Summary
+      description: One paragraph description of the feature
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Why should this be worked on?
+      description: A concise description of the problems or use cases for this feature request
+    validations:
+      required: true
+  - type: dropdown
+    id: repository
+    attributes:
+      label: Repository
+      options:
+        - tailcall
+        - tailcallhq.github.io
+        - homebrew-tailcall
+        - tailcall-on-aws
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        Please add the respective Label to the Issue
diff --git a/.github/codespell-ignore b/.github/codespell-ignore
@@ -0,0 +1,2 @@
+crate
+unit
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -21,8 +21,8 @@ jobs:
       - name: Check spelling
         uses: codespell-project/actions-codespell@v2
         with:
+          ignore_words_file: .github/codespell-ignore
           skip: .git,**/*.png,**/*.gif,**/*.jpg,**/*.svg,**/*.ico,**/*.json,package.json,package-lock.json,*.lock
-          ignore_words_list: unit
 
       - name: Install and Build 🔧
         run: |

diff --git a/docs/contributors/_category_.json b/docs/contributors/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Contributors",
+  "position": 6
+}
diff --git a/docs/contributors/bounty.md b/docs/contributors/bounty.md
@@ -0,0 +1,39 @@
+---
+title: "Bounty"
+description: "This guide outlines the Tailcall Bounty Program, emphasizing quick, high-quality contributions and collaborative engagement through challenges and rewards. It provides essential participation rules and encourages active community involvement for innovation and excellence."
+sidebar_position: 2
+---
+
+Hey there! We're thrilled that you're considering joining our Bounty Program. This is your chance to showcase your skills and get rewarded for them. Here's everything you need to know to dive in and make a splash.
+
+## Our Philosophy
+
+We’re all about meritocracy here. That means the best ideas and implementations win! We love seeing your quality work and fast moves. And yes, we recognize and appreciate your efforts when you exceed expectations.
+
+## Quick & Quality
+
+- **Speedy Gonzalez:** We like fast results! Quick feedback, quick updates. The faster, the better!
+- **A+ Quality:** But hey, don’t rush it if it means cutting corners. We want your best – make it shine!
+
+## Teamwork Makes the Dream Work
+
+- **Join Us on Discord:** Our [Discord](https://discord.gg/kRZBPpkgwq) server is THE place to collaborate, get tips, and find your next bestie. Let’s make magic together.
+- **Share the Love:** Inspired by someone’s PR? Working together? Feel free to [/split](https://docs.algora.io/commands) that bounty – sharing is caring!
+
+## How to Dive In
+
+1. **Pick a Challenge:** Use `/attempt` in the comments to call dibs on an issue. It’s like saying “I got this!”
+2. **Show Your Work:** Got an issue? Great! Now, whip up a draft PR within 24 hours to show you’re on it.
+3. **Go for Gold:** Once you’re ready, switch that draft to Ready for Review. Make sure it’s polished and gleaming!
+4. **Extra Mile Alert:** We’ve got bonuses for those who add that special touch. Clean up, optimize, or fix something extra? We’re here for it!
+
+## The Rules of the Game
+
+- **Be Quick or Be… Late:** No PR within 24 hours? Then it’s open season for that issue again.
+- **There Can Be One Winner:** Multiple folks can try, but it's the top PR that emerges victorious. If there's a tie, the first submission takes the prize.
+- **No Copycats:** Be original; be yourself. Avoid merely copying someone else's hard work.
+- **Consider Before You Contribute:** If there’s already a PR in progress, perhaps take a moment to review it before submitting your own.
+
+## Wrapping Up
+
+We’re stoked to have you! This program is your chance to shine and get rewarded while at it. Stick to these friendly guidelines, and let’s make something awesome together. We look forward to seeing what you bring to the table.