Skip to content

Commit

Permalink
Add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
alex2276564 committed Nov 1, 2024
1 parent 86dce25 commit 72602d5
Show file tree
Hide file tree
Showing 6 changed files with 363 additions and 149 deletions.
109 changes: 109 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
name: Bug Report
description: Report a bug in TelegramNotifier for PrestaShop
title: "[Bug]: "
labels: ["bug"]
body:
- type: dropdown
id: hosting-type
attributes:
label: Hosting Type
description: What type of hosting are you using?
options:
- "Shared Hosting"
- "VPS/VDS"
- "Dedicated Server"
- "Cloud Hosting (AWS, Google Cloud, etc.)"
- "Local Development"
- "Other"
- "Not sure"
validations:
required: true

- type: input
id: hosting-provider
attributes:
label: Hosting Provider
description: Who is your hosting provider?
placeholder: "e.g., Hostinger, OVH, AWS, etc."
validations:
required: false

- type: input
id: prestashop-version
attributes:
label: PrestaShop Version
description: What version of PrestaShop are you running?
placeholder: "e.g., 8.2.0"
validations:
required: true

- type: input
id: php-version
attributes:
label: PHP Version
description: What version of PHP are you running?
placeholder: "e.g., 8.1"
validations:
required: true

- type: input
id: module-version
attributes:
label: TelegramNotifier Version
description: What version of TelegramNotifier are you using?
placeholder: "e.g., 1.0.0"
validations:
required: true

- type: dropdown
id: notification-type
attributes:
label: Notification Type
description: Which type of notification is affected?
options:
- "Order notifications"
- "Admin login notifications"
- "Update notifications"
- "Test message"
- "All notifications"
- "Other"
validations:
required: true

- type: textarea
id: what-happened
attributes:
label: What happened?
description: Describe the bug and how to reproduce it
placeholder: |
1. Go to module configuration...
2. Set up the following...
3. Try to...
4. See error...
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: What did you expect to happen?
validations:
required: true

- type: textarea
id: logs
attributes:
label: PrestaShop Logs
description: Please copy and paste any relevant logs from Advanced Parameters > Logs
render: shell

- type: textarea
id: configuration
attributes:
label: Module Configuration
description: Please provide your module configuration (remove sensitive data like bot token)
placeholder: |
- Message template used
- Max messages per order setting
- Other relevant settings
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
blank_issues_enabled: false
contact_links:
- name: Documentation
url: https://github.com/alex2276564/TelegramNotifier#readme
about: Check out the documentation for installation and configuration guide

- name: Telegram Bot Father
url: https://t.me/BotFather
about: Create your Telegram bot here

- name: PrestaShop Documentation
url: https://devdocs.prestashop.com/
about: Official PrestaShop documentation
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Feature Request
description: Suggest an idea for TelegramNotifier
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: "Thanks for helping improve TelegramNotifier!"

- type: textarea
id: feature-description
attributes:
label: Feature Description
description: Describe the feature you'd like to see added
placeholder: A clear description of what you want to happen
validations:
required: true

- type: dropdown
id: feature-type
attributes:
label: Feature Type
description: What type of feature is this?
options:
- "New notification type"
- "New placeholder"
- "Security enhancement"
- "Performance improvement"
- "User interface improvement"
- "Integration with other services"
- "Other enhancement"
validations:
required: true

- type: textarea
id: use-case
attributes:
label: Use Case
description: Describe how this feature would be useful
placeholder: "This feature would help when..."
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternative Solutions
description: Describe any alternative solutions you've considered
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Question
description: Ask a question about TelegramNotifier
title: "[Question]: "
labels: ["question"]
body:
- type: markdown
attributes:
value: "Thanks for your interest in TelegramNotifier!"

- type: textarea
id: question
attributes:
label: Your Question
description: What would you like to know about TelegramNotifier?
placeholder: Please be as specific as possible
validations:
required: true

- type: dropdown
id: category
attributes:
label: Question Category
description: What is your question about?
options:
- "Installation"
- "Configuration"
- "Telegram Bot Setup"
- "Message Templates"
- "Notifications"
- "Performance"
- "Security"
- "Other"
validations:
required: true
10 changes: 10 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// VS Code uses stricter schema validation for GitHub Issue Template forms.
// However, these are false errors - the config.yml file has the correct format for GitHub Issue Templates.
{
"yaml.schemas": {
"https://json.schemastore.org/github-issue-config.json": "/.github/ISSUE_TEMPLATE/config.yml"
},
"yaml.customTags": [
"!reference sequence"
]
}
Loading

0 comments on commit 72602d5

Please sign in to comment.