diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b5394aa48..06f33b07e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,11 +8,19 @@ For detailed coding standards and full documentation, visit **[community-scripts ## How Can I Help? -| I want to… | Go here | +> [!IMPORTANT] +> **New scripts** must always be submitted to [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) first — not to this repository. +> PRs with new scripts opened directly against ProxmoxVE **will be closed without review**. +> **Bug fixes, improvements, and features for existing scripts** go here (ProxmoxVE). + +| I want to… | Where to go | | :--- | :--- | -| Add a new script or improve an existing one | Read this guide, then open a PR | +| **Add a brand-new script** | [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) — testing repo for new scripts | +| **Fix a bug or improve an existing script** | This repo (ProxmoxVE) — open a PR here | +| **Add a feature to an existing script** | This repo (ProxmoxVE) — open a PR here | | Report a bug or broken script | [Open an Issue](https://github.com/community-scripts/ProxmoxVE/issues) | | Request a new script or feature | [Start a Discussion](https://github.com/community-scripts/ProxmoxVE/discussions) | +| Report a security vulnerability | [Security Policy](SECURITY.md) | | Chat with contributors | [Discord](https://discord.gg/3AnUqsXnmK) | --- @@ -43,41 +51,45 @@ Use existing scripts in [`ct/`](ct/) and [`install/`](install/) as reference. Fu ## Contribution Process -### 1. Fork and clone +### Adding a new script -Fork the repository to your GitHub account, then clone it: +New scripts are **not accepted directly in this repository**. The workflow is: -```bash -git clone https://github.com/YOUR_USERNAME/ProxmoxVE -cd ProxmoxVE -``` - -### 2. Create a branch - -```bash -git switch -c feat/myapp -``` - -### 3. Write your scripts - -Create the two required files for your service: - -- `ct/myapp.sh` -- `install/myapp-install.sh` +1. Fork [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) and clone it +2. Create a branch: `git switch -c feat/myapp` +3. Write your two script files: + - `ct/myapp.sh` + - `install/myapp-install.sh` +4. Test thoroughly in ProxmoxVED — run the script against a real Proxmox instance +5. Open a PR in **ProxmoxVED** for review and testing +6. Once accepted and verified there, the script will be promoted to ProxmoxVE by maintainers Follow the coding standards at [community-scripts.org/docs/contribution](https://community-scripts.org/docs/contribution). -### 4. Test in ProxmoxVED +--- -**Do not open a PR against the main repo without testing first.** +### Fixing a bug or improving an existing script -Submit your scripts to [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) — the dedicated testing repository. PRs to the main repo without prior testing in ProxmoxVED will not be merged quickly. +Changes to scripts that already exist in ProxmoxVE go directly here: -### 5. Open a Pull Request +1. Fork **this repository** (ProxmoxVE) and clone it: -Once testing is complete, open a PR from your fork to `community-scripts/ProxmoxVE/main`. + ```bash + git clone https://github.com/YOUR_USERNAME/ProxmoxVE + cd ProxmoxVE + ``` -Your PR should only contain the files you created or modified. Do not include unrelated changes. +2. Create a branch: + + ```bash + git switch -c fix/myapp-description + ``` + +3. Make your changes to the relevant files in `ct/` and/or `install/` + +4. Open a PR from your fork to `community-scripts/ProxmoxVE/main` + +Your PR should only contain the files you changed. Do not include unrelated modifications. --- @@ -120,6 +132,7 @@ dev_mode="trace,keep" bash -c "$(curl -fsSL https://raw.githubusercontent.com/co - **Website metadata** (name, description, logo, tags) is managed via the website — use the "Report Issue" link on any script page to request changes. Do not submit metadata changes via repo files. - **JSON files** in `json/` define script properties used by the website. See existing files for structure reference. -- Keep PRs small and focused. One script addition or fix per PR is ideal. -- PRs that fail CI checks or that haven't been tested in ProxmoxVED will not be merged. +- Keep PRs small and focused. One fix or feature per PR is ideal. +- PRs with **new scripts** opened against ProxmoxVE will be closed — submit them to [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) instead. +- PRs that fail CI checks will not be merged. diff --git a/README.md b/README.md index d89eb9265..90d42215d 100644 --- a/README.md +++ b/README.md @@ -93,17 +93,18 @@ This project runs on community contributions. Whether you want to write new scri | I want to… | Go here | | ------------------------------------------- | ------------------------------------------------------------------------- | -| Add a new script or improve an existing one | [Contributing Guidelines](CONTRIBUTING.md) | -| Test scripts before they hit production | [ProxmoxVED (dev repo)](https://github.com/community-scripts/ProxmoxVED) | +| Add a **new** script | [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) — new scripts are tested here first | +| Fix or improve an **existing** script | [Contributing Guidelines](CONTRIBUTING.md) — open a PR in this repo | | Report a bug or broken script | [Issues](https://github.com/community-scripts/ProxmoxVE/issues) | | Request a new script or feature | [Discussions](https://github.com/community-scripts/ProxmoxVE/discussions) | +| Report a security vulnerability | [Security Policy](SECURITY.md) | | Get help or chat with other users | [Discord](https://discord.gg/3AnUqsXnmK) | ### Before you open a PR -- Read the [Contributing Guidelines](CONTRIBUTING.md) — they cover script structure, variable naming, and how the review process works. -- Test your changes in [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) first. PRs against the main repo without prior testing in VED are unlikely to be merged quickly. -- Keep scripts focused. One script, one service. +- **New scripts go to [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED), not here.** PRs with new scripts opened directly against this repo will be closed. +- Bug fixes and improvements to existing scripts belong in this repo — read the [Contributing Guidelines](CONTRIBUTING.md) first. +- Keep PRs focused. One fix or feature per PR. - Document what your script installs and any non-obvious decisions in the corresponding JSON metadata file. ---