Merge pull request #16 from dograh-hq/feat/issue-templates

feat: add issue templates
This commit is contained in:
Sabiha Khan 2025-09-30 19:22:24 +05:30 committed by GitHub
commit 35c9ab7b07
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 134 additions and 4 deletions

53
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View file

@ -0,0 +1,53 @@
name: "🐞 Bug Report"
description: "Create a report to help us improve"
title: "[Bug]: "
labels: [bug]
assignees: []
body:
- type: textarea
id: description
attributes:
label: "Describe the bug"
description: "A clear and concise description of what the bug is."
placeholder: "The application crashes when..."
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: "Steps to Reproduce"
description: "Step-by-step instructions to reproduce the behavior."
placeholder: "1. Go to...\n2. Click...\n3. Scroll...\n4. See error"
validations:
required: true
- type: textarea
id: expected
attributes:
label: "Expected behavior"
description: "What you expected to happen."
placeholder: "The application should..."
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: "Screenshots"
description: "If applicable, add screenshots to help explain your problem."
placeholder: "Drag & drop images here"
- type: input
id: desktop
attributes:
label: "Device details"
description: "Device, OS, Browser, Version"
placeholder: "e.g. Desktop, macOS, Chrome, 119"
- type: textarea
id: additional
attributes:
label: "Additional context"
description: "Add any other context about the problem here."

7
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View file

@ -0,0 +1,7 @@
contact_links:
- name: 💡 Feature Request
url: https://github.com/orgs/dograh-hq/discussions/new?category=ideas
about: Suggest any ideas you have using our discussion forums.
- name: "🔒 Report a Security Vulnerability"
url: https://github.com/dograh-hq/dograh/security/advisories/new
about: "Privately report security vulnerabilities to maintainers (not via public issues)."

View file

@ -0,0 +1,52 @@
name: "📖 Documentation Change Request"
description: "Suggest improvements, corrections, or additions to the documentation"
title: "[Docs]: "
labels: [documentation]
body:
- type: markdown
attributes:
value: |
Thanks for helping improve our documentation!
Please fill out the details below so we can make updates faster.
- type: dropdown
id: type-of-change
attributes:
label: "Type of Documentation Change"
options:
- Fix typo or grammar
- Update outdated content
- Add missing content
- Improve clarity or formatting
- Other
validations:
required: true
- type: input
id: page-url
attributes:
label: "Affected Page/Section"
description: "Link to the page or file that needs an update (if applicable)"
placeholder: "docs/installation.md or https://project/docs/installation"
- type: textarea
id: current
attributes:
label: "Current Content"
description: "What does the documentation currently say?"
placeholder: "Paste or summarize the current content here"
- type: textarea
id: suggested
attributes:
label: "Suggested Change"
description: "What should it say instead? Suggest edits or improvements."
placeholder: "Propose corrected text, examples, or explanation here"
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: "Additional Context"
description: "Add any extra details, screenshots, or references"

View file

@ -20,4 +20,4 @@ jobs:
run: chmod +x scripts/*.sh
- name: Check pipecat version synchronization
run: ./scripts/check-pipecat-sync.sh
run: ./scripts/check_pipecat_sync.sh

View file

@ -31,10 +31,10 @@ jobs:
- name: Check pipecat version sync
id: version-check
run: |
chmod +x scripts/check-pipecat-sync.sh
chmod +x scripts/check_pipecat_sync.sh
# Capture the output for version details
if OUTPUT=$(./scripts/check-pipecat-sync.sh 2>&1); then
if OUTPUT=$(./scripts/check_pipecat_sync.sh 2>&1); then
echo "version_mismatch=false" >> $GITHUB_OUTPUT
else
echo "version_mismatch=true" >> $GITHUB_OUTPUT

18
SECURITY.md Normal file
View file

@ -0,0 +1,18 @@
# Security Policy
At Dograh we look forward to working with security researchers across the world to keep Dograh and our users safe. If you have found an issue in any of our services, please reach out to us.
## Supported Versions
We always recommend using the latest versions of services to ensure you get all security updates
## Reporting a Vulnerability
If you believe you have found a security vulnerability within Dograh, please let us know right away. We'll try and fix the problem as soon as possible.
**Do not report vulnerabilities using public GitHub issues**. Instead, report the issue [here](https://github.com/dograh-hq/dograh/security/advisories/new)
Once we've received your email we'll keep you updated as we fix the vulnerability.
## Thanks
Thank you for keeping Dograh and our users safe. 🙇

View file

@ -1,6 +1,6 @@
#!/usr/bin/env bash
#
# check-pipecat-sync.sh
# check_pipecat_sync.sh
#
# Verifies that the pipecat submodule commit SHA matches the one in Dockerfile.
# Used by CI/CD to ensure versions are synchronized before merging.