add issue templates and add release notifier

This commit is contained in:
Divarion-D
2025-07-10 20:48:38 +03:00
parent ebfd4a287b
commit cf6f6aef12
6 changed files with 283 additions and 0 deletions

36
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,36 @@
name: Bug Report
description: Create a report to help us improve
title: '[BUG]: bug name'
labels: [bug]
body:
- type: markdown
attributes:
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
- type: checkboxes
attributes:
label: I have searched through the issues and didn't find my problem.
options:
- label: Confirm
required: true
- type: textarea
id: description
attributes:
label: Bug description
description: Short description of the bug. Provide images/code if applicable.
validations:
required: true
- type: textarea
id: howtoreplicate
attributes:
label: Possible fixes or solutions
description: List any possible fixes/suggestions that you have in mind that could solve this issue.
- type: textarea
id: extrainformation
attributes:
label: Additional information
description: Is there anything else we should know about this bug?

View File

@@ -0,0 +1,70 @@
name: Documentation Issue
description: Report an issue or suggest an improvement for the documentation
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
Thank you for helping us improve our documentation! Please provide the details below.
- type: input
id: title
attributes:
label: Title
description: A brief title describing the documentation issue or suggestion.
placeholder: Improve setup guide for new users
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: |
Provide a detailed description of the documentation issue or improvement.
Include links, screenshots, or code snippets if applicable.
placeholder: The current setup guide lacks details about environment configuration...
validations:
required: true
- type: input
id: location
attributes:
label: Location
description: Specify the location of the documentation (e.g., file name or section).
placeholder: docs/setup.md or "Getting Started" section
validations:
required: false
- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this documentation issue?
options:
- High
- Medium
- Low
validations:
required: false
- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Include any other relevant details or suggestions.
placeholder: Add a step-by-step example for setup...
validations:
required: false
- type: checkboxes
id: agreement
attributes:
label: Agreement
description: Confirm the following before submitting.
options:
- label: I have checked existing documentation to ensure this is not already addressed.
required: true
- label: I am willing to help update the documentation if needed.
required: false

View File

@@ -0,0 +1,43 @@
name: Feature Request
description: Requesting a new feature or changes to an existing feature
title: '[FEATURE REQUEST]: feature name'
labels: [enhancement]
body:
- type: markdown
attributes:
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
- type: checkboxes
attributes:
label: "I have searched through the issues and didn't find my problem."
options:
- label: Confirm
required: true
- type: textarea
id: description
attributes:
label: Description
description: Write down a detailed description of the feature.
validations:
required: true
- type: textarea
id: context
attributes:
label: Context
description: Why is this change important to you? How would you use it? How can it benefit other users?
validations:
required: true
- type: textarea
id: possiblesolution
attributes:
label: Possible Solution
description: If you have an idea, please tell us what might solve the above problem and the benefits it provides.
- type: textarea
id: extrainformation
attributes:
label: Additional information
description: Is there anything else we should know about this feature request?

29
.github/ISSUE_TEMPLATE/other.yml vendored Normal file
View File

@@ -0,0 +1,29 @@
name: Other
description: Use this for any other issues. Please do NOT create blank issues
title: "[OTHER]: description"
labels: ["awaiting triage"]
body:
- type: markdown
attributes:
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
- type: checkboxes
attributes:
label: I have searched through the issues and didn't find my problem.
options:
- label: Confirm
required: true
- type: textarea
id: issuedescription
attributes:
label: What would you like to share?
description: Provide a clear and concise explanation of your issue.
validations:
required: true
- type: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this issue?

62
.github/ISSUE_TEMPLATE/security.yml vendored Normal file
View File

@@ -0,0 +1,62 @@
name: "Security Issue"
description: "Report a security vulnerability in the project."
title: "[SECURITY] Brief description of the issue"
labels: ["security", "bug"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report a security vulnerability.
Please ensure that you provide as much detail as possible to help us address the issue efficiently.
**Do not disclose the details of this issue publicly until it has been resolved.**
- type: textarea
id: vulnerability_description
attributes:
label: "Describe the Vulnerability"
description: "Provide a clear and concise description of the vulnerability."
placeholder: "What is the issue? How can it be exploited?"
validations:
required: true
- type: textarea
id: reproduction_steps
attributes:
label: "Steps to Reproduce"
description: "List the steps to reproduce the vulnerability."
placeholder: |
1. Go to...
2. Click on...
3. Observe...
validations:
required: true
- type: textarea
id: expected_behavior
attributes:
label: "Expected Behavior"
description: "Describe what should happen if the vulnerability did not exist."
placeholder: "What should have happened instead?"
validations:
required: true
- type: textarea
id: impact
attributes:
label: "Impact"
description: "Describe the potential impact of this vulnerability (e.g., data loss, unauthorized access)."
placeholder: "What is the potential damage caused by this vulnerability?"
validations:
required: true
- type: textarea
id: additional_information
attributes:
label: "Additional Information"
description: "Include any other relevant information, such as affected versions or related issues."
placeholder: "Version numbers, configurations, or related vulnerabilities."
- type: checkboxes
id: confidentiality
attributes:
label: "Confidentiality Acknowledgment"
description: "By submitting this report, you agree not to disclose the details of this vulnerability until it has been addressed."
options:
- label: "I agree to keep the details of this vulnerability confidential."
required: true

43
.github/workflows/release-notifier.yml vendored Normal file
View File

@@ -0,0 +1,43 @@
name: Release Notifier
on:
release:
types: [published]
jobs:
notify-telegram:
runs-on: ubuntu-latest
steps:
- name: Send Release Notification to Telegram
env:
BOT_TOKEN: ${{ secrets.TELEGRAM_BOT_TOKEN }}
CHAT_ID: ${{ secrets.TELEGRAM_CHAT_ID }}
TOPIC_ID: ${{ secrets.TELEGRAM_TOPIC_ID }}
run: |
RELEASE_TYPE="Release"
if [ "${{ github.event.release.prerelease }}" == "true" ]; then
RELEASE_TYPE="Prerelease"
fi
RELEASE_TAG=${GITHUB_REF#refs/tags/}
MESSAGE=$(cat <<EOF
🔔 *${RELEASE_TYPE} Published* 🔔
📦 *Repository:* [${{ github.repository }}](https://github.com/${{ github.repository }})
🏷 *Version:* \`${RELEASE_TAG}\`
📛 *Title:* ${{ github.event.release.name }}
🔗 [View Release](https://github.com/${{ github.repository }}/releases/tag/${RELEASE_TAG})
EOF
)
curl -s -X POST \
-H "Content-Type: application/json" \
-d "{
\"chat_id\": \"$CHAT_ID\",
\"message_thread_id\": \"$TOPIC_ID\",
\"text\": \"$MESSAGE\",
\"parse_mode\": \"Markdown\"
}" \
"https://api.telegram.org/bot$BOT_TOKEN/sendMessage"