diff --git a/.github/DISCUSSIONS_GUIDELINES.md b/.github/DISCUSSIONS_GUIDELINES.md new file mode 100644 index 0000000..fb7062e --- /dev/null +++ b/.github/DISCUSSIONS_GUIDELINES.md @@ -0,0 +1,9 @@ +# Community Guidelines +Be kind, be specific, and share context. Maintainers review new threads weekly. + +**Good posts include:** +- Clear title and steps +- Links to bins (sanitize secrets) +- Expected vs actual behavior + +We may convert high-signal ideas into Issues. Thank you for helping improve RequestBin! diff --git a/.github/DISCUSSION_TEMPLATE/announcements.yml b/.github/DISCUSSION_TEMPLATE/announcements.yml new file mode 100644 index 0000000..16d2427 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/announcements.yml @@ -0,0 +1,13 @@ +labels: ["announcement"] +category: Announcements +body: + - type: markdown + attributes: + value: | + ## Release / Update + Summarize what's new, links to apps and docs. + - type: textarea + id: notes + attributes: + label: Notes + description: Changelog highlights, thanks to contributors. diff --git a/.github/DISCUSSION_TEMPLATE/docs-feedback.yml b/.github/DISCUSSION_TEMPLATE/docs-feedback.yml new file mode 100644 index 0000000..1205760 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/docs-feedback.yml @@ -0,0 +1,24 @@ +labels: ["discussion: docs"] +category: Docs Feedback +body: + - type: markdown + attributes: + value: | + Help us improve the docs. Please include the page link. + - type: input + id: page + attributes: + label: Docs page URL + placeholder: https://requestbin.net/docs/... or /apps/.../docs + validations: + required: true + - type: textarea + id: issue + attributes: + label: What's missing or unclear? + validations: + required: true + - type: textarea + id: suggestion + attributes: + label: Your suggested fix or example diff --git a/.github/DISCUSSION_TEMPLATE/ideas-feedback.yml b/.github/DISCUSSION_TEMPLATE/ideas-feedback.yml new file mode 100644 index 0000000..60db34b --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/ideas-feedback.yml @@ -0,0 +1,35 @@ +labels: ["discussion: idea"] +category: Ideas & Feedback +body: + - type: markdown + attributes: + value: | + Share your idea! High-signal posts are easier to prioritize. + - type: input + id: what + attributes: + label: What would you like to build or improve? + placeholder: New App – DNS Callback Inspector + validations: + required: true + - type: textarea + id: problem + attributes: + label: Problem / use case + description: What problem does this solve? Who benefits? + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposal / rough design + description: Sketch the UI flow or APIs if relevant. + - type: checkboxes + id: scope + attributes: + label: Scope + options: + - label: App page + - label: Bin integration + - label: Docs update + - label: SDK/API diff --git a/.github/DISCUSSION_TEMPLATE/q-a-support.yml b/.github/DISCUSSION_TEMPLATE/q-a-support.yml new file mode 100644 index 0000000..22f06ec --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/q-a-support.yml @@ -0,0 +1,36 @@ +labels: ["discussion: q&a"] +category: Q&A / Support +body: + - type: markdown + attributes: + value: | + Thanks for opening a Q&A! Please provide enough detail so others can help. + - type: input + id: topic + attributes: + label: Topic summary + description: One sentence describing the question. + placeholder: e.g., How to inspect SMTP callbacks? + validations: + required: true + - type: textarea + id: details + attributes: + label: Details + description: Steps tried, expected vs actual, screenshots, etc. + validations: + required: true + - type: dropdown + id: area + attributes: + label: Area + options: + - App Hub / Apps + - Inspect / Bin + - Docs + - Other + - type: input + id: links + attributes: + label: Links + description: Optional links (bin URL without secrets, docs page, etc.) diff --git a/.github/DISCUSSION_TEMPLATE/show-and-tell.yml b/.github/DISCUSSION_TEMPLATE/show-and-tell.yml new file mode 100644 index 0000000..36bddd8 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/show-and-tell.yml @@ -0,0 +1,21 @@ +labels: ["discussion: show"] +category: Show & Tell / Use cases +body: + - type: markdown + attributes: + value: | + Share what you built with RequestBin! Links and screenshots welcome. + - type: input + id: title + attributes: + label: Project title + placeholder: Slack bot using RequestBin Apps + validations: + required: true + - type: textarea + id: description + attributes: + label: Description & links + description: Repo/demo link, what it does, and how RequestBin helped. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..8865c33 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: πŸ’¬ Q&A / Support (GitHub Discussions) + url: https://github.com/orgs/requestbin/discussions/categories/q-a-support + about: Ask questions and get help from the community and maintainers. + - name: πŸ’‘ Ideas & Feature Requests (Discussions) + url: https://github.com/orgs/requestbin/discussions/categories/ideas-feedback + about: Propose new apps, features, or improvements. + - name: πŸ“š Docs Feedback (Discussions) + url: https://github.com/orgs/requestbin/discussions/categories/docs-feedback + about: Suggest edits, report gaps, or ask for examples. + - name: πŸš€ Show & Tell / Use cases (Discussions) + url: https://github.com/orgs/requestbin/discussions/categories/show-and-tell + about: Share what you built with RequestBin. diff --git a/.github/PINNED_TOPICS.md b/.github/PINNED_TOPICS.md new file mode 100644 index 0000000..b204f6c --- /dev/null +++ b/.github/PINNED_TOPICS.md @@ -0,0 +1,68 @@ +# Pinned Discussion Topics + +These topics should be created and pinned manually in GitHub Discussions after enabling the feature. + +--- + +## Topic 1: Welcome to Discussions + +**Category:** General or Announcements + +**Content:** + +```markdown +πŸ‘‹ Welcome to RequestBin Discussions! +Use this space to ask questions, share feedback, and propose new Apps. +- πŸ’¬ Q&A / Support +- πŸ’‘ Ideas & Feedback +- πŸ“š Docs Feedback +- πŸš€ Show & Tell + +We summarize top threads monthly and promote strong ideas to Issues. +``` + +--- + +## Topic 2: Suggest a new App idea + +**Category:** Ideas & Feedback + +**Content:** + +```markdown +Got an idea for a RequestBin App? +1) Problem/use case +2) Proposed solution (sketch UI/API) +3) Impact (who benefits?) + +Maintainers label promising ideas and may convert them to Issues. +``` + +--- + +## Topic 3: Docs & Content Feedback + +**Category:** Docs Feedback + +**Content:** + +```markdown +Help us improve the docs! Share the page link, the gap you found, and your suggested fix. Great suggestions get credited in release notes. +``` + +--- + +## Setup Instructions + +After pushing these changes to the default branch: + +1. **Enable Discussions** in repository settings +2. **Create categories:** + - Q&A / Support + - Ideas & Feedback + - Docs Feedback + - Show & Tell / Use cases + - Announcements +3. **Map each category form** in Settings β†’ Discussions β†’ Category forms +4. **Create and pin** the three topics above +5. **Verify workflow** by testing the `/promote` command in a discussion diff --git a/.github/SETUP_SUMMARY.md b/.github/SETUP_SUMMARY.md new file mode 100644 index 0000000..a2bd7d7 --- /dev/null +++ b/.github/SETUP_SUMMARY.md @@ -0,0 +1,103 @@ +# GitHub Discussions Setup - Implementation Complete βœ… + +All configuration files have been created and committed according to the guide. + +## βœ… Completed Items + +1. **Issue Template Configuration** - `.github/ISSUE_TEMPLATE/config.yml` + - Redirects users to Discussions with proper category links + - Disables blank issues + +2. **Discussion Templates** - `.github/DISCUSSION_TEMPLATE/` + - βœ… `q-a-support.yml` - Q&A / Support category form + - βœ… `ideas-feedback.yml` - Ideas & Feedback category form + - βœ… `docs-feedback.yml` - Docs Feedback category form + - βœ… `show-and-tell.yml` - Show & Tell / Use cases category form + - βœ… `announcements.yml` - Announcements category form + +3. **GitHub Actions Workflow** - `.github/workflows/discussion-promote.yml` + - Auto-promotes Ideas/Feedback discussions to issues with `/promote` command + +4. **Community Guidelines** - `.github/DISCUSSIONS_GUIDELINES.md` + - Sets expectations for good posts + +5. **README Updates** - `README.md` + - βœ… Added GitHub Discussions badge + - βœ… Updated Community & Support section with Discussions link + +6. **Pinned Topics Documentation** - `.github/PINNED_TOPICS.md` + - Contains content for 3 pinned topics to be created manually + +## πŸ“‹ Manual Steps Required (Post-Merge) + +After these changes are merged to the default branch, complete the following in GitHub Settings: + +### Step 1: Enable Discussions +1. Go to **Settings** β†’ **General** β†’ **Features** +2. Check **"Discussions"** + +### Step 2: Create Discussion Categories +1. Go to **Settings** β†’ **Discussions** +2. Create the following categories: + - **Q&A / Support** (Q&A format) + - **Ideas & Feedback** (Open discussion) + - **Docs Feedback** (Open discussion) + - **Show & Tell / Use cases** (Show and tell format) + - **Announcements** (Announcement format, maintainers only) + +### Step 3: Map Category Forms +1. In **Settings** β†’ **Discussions** β†’ **Category forms** +2. Map each template to its matching category: + - `q-a-support.yml` β†’ Q&A / Support + - `ideas-feedback.yml` β†’ Ideas & Feedback + - `docs-feedback.yml` β†’ Docs Feedback + - `show-and-tell.yml` β†’ Show & Tell / Use cases + - `announcements.yml` β†’ Announcements + +### Step 4: Create and Pin Topics +Create these three discussions and pin them (see `.github/PINNED_TOPICS.md` for full content): + +1. **Welcome to Discussions** (General/Announcements) + - Overview of how to use Discussions + +2. **Suggest a new App idea** (Ideas & Feedback) + - Template for app proposals + +3. **Docs & Content Feedback** (Docs Feedback) + - Encourage documentation improvements + +### Step 5: Test the Workflow +1. Create a test discussion in Ideas & Feedback +2. Comment with `/promote` to test the workflow +3. Verify that an issue is created automatically + +## πŸ“ Files Created + +``` +.github/ +β”œβ”€β”€ DISCUSSIONS_GUIDELINES.md +β”œβ”€β”€ DISCUSSION_TEMPLATE/ +β”‚ β”œβ”€β”€ announcements.yml +β”‚ β”œβ”€β”€ docs-feedback.yml +β”‚ β”œβ”€β”€ ideas-feedback.yml +β”‚ β”œβ”€β”€ q-a-support.yml +β”‚ └── show-and-tell.yml +β”œβ”€β”€ ISSUE_TEMPLATE/ +β”‚ └── config.yml +β”œβ”€β”€ PINNED_TOPICS.md +└── workflows/ + └── discussion-promote.yml +``` + +## 🎯 Expected URLs + +Once enabled, Discussions will be available at: +- Main: `https://github.com/orgs/requestbin/discussions` +- Q&A: `https://github.com/orgs/requestbin/discussions/categories/q-a-support` +- Ideas: `https://github.com/orgs/requestbin/discussions/categories/ideas-feedback` +- Docs: `https://github.com/orgs/requestbin/discussions/categories/docs-feedback` +- Show & Tell: `https://github.com/orgs/requestbin/discussions/categories/show-and-tell` + +--- + +**Note:** This is an organization-level `.github` repository, so these configurations will apply to discussions at the organization level. diff --git a/.github/workflows/discussion-promote.yml b/.github/workflows/discussion-promote.yml new file mode 100644 index 0000000..e842470 --- /dev/null +++ b/.github/workflows/discussion-promote.yml @@ -0,0 +1,31 @@ +name: Promote Discussions to Issues +on: + discussion: + types: [created, edited] + discussion_comment: + types: [created] +permissions: + contents: write + issues: write + discussions: read +jobs: + promote: + if: >- + contains(github.event.discussion.category.name, 'Ideas') || + contains(github.event.discussion.category.name, 'Feedback') + runs-on: ubuntu-latest + steps: + - name: Create issue from discussion when label /promote is used + uses: peter-evans/create-issue-from-discussion@v3 + with: + discussion-number: ${{ github.event.discussion.number }} + repository: ${{ github.repository }} + labels: "triage, from:discussion" + - name: Check for /promote command + if: github.event_name == 'discussion_comment' + uses: peter-evans/slash-command-dispatch@v4 + with: + token: ${{ secrets.GITHUB_TOKEN }} + reaction-token: ${{ secrets.GITHUB_TOKEN }} + issue-type: discussion + commands: promote diff --git a/README.md b/README.md index 641fe36..02b353e 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![Blog](https://img.shields.io/badge/Blog-Tech%20Guides%20%26%20Updates-22c55e)](https://blog.requestbin.net) [![Follow @requestbin](https://img.shields.io/twitter/follow/requestbin?style=flat&label=%40requestbin&color=0ea5e9)](https://twitter.com/requestbin) [![Open Source Roots](https://img.shields.io/badge/Open%20Source-Roots-64748b)](https://github.com/requestbin/requestbin.net) +[![GitHub Discussions](https://img.shields.io/github/discussions/orgs/requestbin?label=chat%20%F0%9F%92%AC)](https://github.com/orgs/requestbin/discussions) **RequestBin** helps developers, researchers, and security teams **capture, inspect, and debug requests**β€”from webhooks to OAST flowsβ€”via a **cloud-first platform** and **developer-friendly tooling**. @@ -63,7 +64,7 @@ A lightweight extension that brings **RequestBin-powered collaboration** to Burp We actively support our community of developers and researchers: -- **Issues & Discussions:** Open issues for v2.0 references and plugin feedback +- **πŸ’¬ Questions or ideas?** Join our [GitHub Discussions](https://github.com/orgs/requestbin/discussions) - **Blog:** Deep dives, tutorials, and release notes β†’ https://blog.requestbin.net - **X (Twitter):** Announcements, tips, and threads β†’ https://twitter.com/requestbin