Files
ProxmoxVE/.github/DISCUSSION_TEMPLATE/request-script.yml
T
CanbiZ (MickLesk) bffc871aa9 Flag instead of closing on first PR template miss; add script-request eligibility check (#18384)
close-invalid-pr-template.yml now comments and labels (missing pr template,
stale) instead of closing immediately, clears itself once fixed. stale_pr_close.yml
gains the engagement-gated/keep-open/maintainer-reset behavior already used in
DevScripts, so a template-stale PR only closes via its own re-check.

request-script.yml discussion template gets an optional Justification field;
a new workflow verifies stars/age against GitHub for the submitted repo and
either does nothing (eligible), labels investigation (ineligible + justified),
or closes the discussion (ineligible, no justification).

Moved the AI Assistance section to the end of pull_request_template.md.
2026-11-03 14:58:57 +01:00

158 lines
6.0 KiB
YAML
Generated

title: "[Script request]: "
labels:
- enhancement
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new script for Proxmox VE Helper-Scripts.
Please make sure the requested application fits the scope of this project.
Requests may be closed if the application is out of scope, abandoned, too new, not publicly verifiable, or not suitable for a reliable Proxmox VE Helper-Scripts integration.
General requirements:
- The application must be self-hosted.
- The project must have an official public source repository.
- The project must provide official releases, tags, or release tarballs.
- The project must be actively maintained.
- The official source repository must have at least 1,000 stars.
- The latest official release or tag must not be older than 6 months.
- The project itself must be at least 6 months old.
Projects that do not meet these requirements may be closed without further evaluation.
Exceptions to the 1,000-star requirement are rare and require a clearly verifiable, significant public adoption signal.
- type: input
id: application-name
attributes:
label: Application Name
description: Enter the official application name.
placeholder: "e.g., Home Assistant"
validations:
required: true
- type: input
id: official-website
attributes:
label: Official Website
description: Enter the official website, documentation page, or project homepage.
placeholder: "e.g., https://www.home-assistant.io/"
validations:
required: true
- type: input
id: source-repository
attributes:
label: Source Repository
description: Enter the official GitHub, GitLab, Forgejo, or other public source repository URL.
placeholder: "e.g., https://github.com/home-assistant/core"
validations:
required: true
- type: markdown
attributes:
value: |
## ⚠️ Project Eligibility
Before continuing, verify that the requested project meets the minimum requirements below.
**Projects with fewer than 1,000 stars, or younger than 6 months, are generally not eligible for a script request.**
An automated check verifies the star count and project age for GitHub-hosted projects. If the project doesn't meet these requirements, fill in **Justification for an exception** below — without one, the request is closed automatically. With one, it's flagged for manual review instead. Exceptions are rare and require a clearly verifiable, significant public adoption signal.
- type: input
id: repository-stars
attributes:
label: Repository Stars
description: Enter the current number of stars of the official source repository.
placeholder: "e.g., 15,000"
validations:
required: true
- type: checkboxes
id: minimum-stars
attributes:
label: Minimum Adoption Requirement
description: Confirm that you have verified the project's public adoption.
options:
- label: The official source repository has at least 1,000 stars.
required: true
- type: textarea
id: app-description
attributes:
label: Description
description: Explain what the application does.
placeholder: |
Example:
Home Assistant is an open-source platform for managing smart home devices.
validations:
required: true
- type: textarea
id: reason
attributes:
label: Why should this be added?
description: Explain why this application would be useful for Proxmox VE Helper-Scripts users.
placeholder: |
Example:
It is a popular self-hosted application and would be useful for users who want to run it easily in a Proxmox LXC or VM.
validations:
required: true
- type: textarea
id: installation-notes
attributes:
label: Installation Notes
description: Add any relevant installation details, dependencies, ports, databases, services, or known limitations.
placeholder: |
Example:
- Requires PostgreSQL
- Uses port 8123 by default
- Runs as a systemd service
validations:
required: false
- type: checkboxes
id: due-diligence
attributes:
label: Due Diligence
description: Please confirm the following before submitting your request.
options:
- label: I have searched existing scripts and found no duplicate.
required: true
- label: I have searched existing discussions and found no duplicate request.
required: true
- label: The application has an official public source repository.
required: true
- label: The application is self-hosted and suitable for Proxmox VE Helper-Scripts.
required: true
- label: The application appears to be actively maintained and provides official releases, tags, or release tarballs.
required: true
- label: I understand that requests outside the project scope may be closed without an extensive explanation.
required: true
- type: textarea
id: justification
attributes:
label: Justification for an exception
description: >-
Only needed if the project has fewer than 1,000 stars or is younger than 6 months (e.g. it has no GitHub
presence, so stars don't apply). Explain the significant public adoption signal. Leave blank if the project
meets the normal requirements — requests that don't meet the requirements and have no justification here are
closed automatically.
placeholder: |
Example:
No public GitHub repository, but the project has 50k+ active installs reported by its own telemetry
dashboard and is covered by several established self-hosting publications.
validations:
required: false
- type: markdown
attributes:
value: |
Thanks for submitting your request.
The team will review it and may ask for more information if needed.