diff --git a/.gitattributes b/.gitattributes index 6336972b9..68acdb5da 100644 --- a/.gitattributes +++ b/.gitattributes @@ -6,19 +6,9 @@ *.func linguist-language=Shell *.install linguist-language=Shell -# --------------------------------------- -# Treat Golang files as Go (for /api/) -api/**/*.go linguist-language=Go - -# --------------------------------------- -# Treat frontend as JavaScript/TypeScript (optional) -frontend/**/*.ts linguist-language=TypeScript -frontend/**/*.js linguist-language=JavaScript - # --------------------------------------- # Exclude documentation from stats *.md linguist-documentation -docs/** linguist-documentation README.md linguist-documentation CONTRIBUTING.md linguist-documentation SECURITY.md linguist-documentation @@ -26,7 +16,6 @@ SECURITY.md linguist-documentation # --------------------------------------- # Exclude generated/config files *.json linguist-generated -frontend/public/json/*.json linguist-generated=false *.lock linguist-generated *.yml linguist-generated *.yaml linguist-generated diff --git a/.gitignore b/.gitignore index bbc2eb9d6..e03fc3273 100644 --- a/.gitignore +++ b/.gitignore @@ -14,21 +14,6 @@ npm-debug.log* yarn-debug.log* yarn-error.log* -# Python-specific exclusions -__pycache__/ -*.pyc -*.pyo -*.pyd -*.venv/ -venv/ -env/ -*.env - -# API and Backend specific exclusions -api/.env -api/__pycache__/ -api/*.sqlite3 - # Install scripts and temporary files install/tmp/ install/*.bak diff --git a/.vscode/.shellcheckrc b/.shellcheckrc similarity index 100% rename from .vscode/.shellcheckrc rename to .shellcheckrc diff --git a/.vscode/.editorconfig b/.vscode/.editorconfig deleted file mode 100644 index f79a823d7..000000000 --- a/.vscode/.editorconfig +++ /dev/null @@ -1,16 +0,0 @@ -; editorconfig.org -root = true - -[*] -charset = utf-8 -continuation_indent_size = 2 -end_of_line = lf -indent_size = 2 -indent_style = space -insert_final_newline = true -max_line_length = 120 -tab_width = 2 -; trim_trailing_whitespace = true ; disabled until files are cleaned up - -[*.md] -trim_trailing_whitespace = false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06f33b07e..6493ff4f6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,15 +13,15 @@ For detailed coding standards and full documentation, visit **[community-scripts > 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 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) | +| I want to… | Where to go | +| :------------------------------------------ | :------------------------------------------------------------------------------------------- | +| **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) | --- @@ -40,10 +40,10 @@ Before writing scripts, we recommend setting up: Every script consists of two files: -| File | Purpose | -| :--- | :--- | -| `ct/AppName.sh` | Container creation, variable setup, and update handling | -| `install/AppName-install.sh` | Application installation logic | +| File | Purpose | +| :--------------------------- | :------------------------------------------------------ | +| `ct/AppName.sh` | Container creation, variable setup, and update handling | +| `install/AppName-install.sh` | Application installation logic | Use existing scripts in [`ct/`](ct/) and [`install/`](install/) as reference. Full coding standards and annotated templates are at **[community-scripts.org/docs/contribution](https://community-scripts.org/docs/contribution)**. @@ -116,15 +116,15 @@ Set the `dev_mode` variable to enable debugging features when testing. Flags can dev_mode="trace,keep" bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/myapp.sh)" ``` -| Flag | Description | -| :--- | :--- | -| `trace` | Enables `set -x` for maximum verbosity during execution | -| `keep` | Prevents the container from being deleted if the build fails | -| `pause` | Pauses execution at key points before customization | -| `breakpoint` | Drops to a shell at hardcoded `breakpoint` calls in scripts | -| `logs` | Saves detailed build logs to `/var/log/community-scripts/` | -| `dryrun` | Bypasses actual container creation (limited support) | -| `motd` | Forces an update of the Message of the Day | +| Flag | Description | +| :----------- | :----------------------------------------------------------- | +| `trace` | Enables `set -x` for maximum verbosity during execution | +| `keep` | Prevents the container from being deleted if the build fails | +| `pause` | Pauses execution at key points before customization | +| `breakpoint` | Drops to a shell at hardcoded `breakpoint` calls in scripts | +| `logs` | Saves detailed build logs to `/var/log/community-scripts/` | +| `dryrun` | Bypasses actual container creation (limited support) | +| `motd` | Forces an update of the Message of the Day | --- @@ -135,4 +135,3 @@ dev_mode="trace,keep" bash -c "$(curl -fsSL https://raw.githubusercontent.com/co - 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 ce2e45218..de874750e 100644 --- a/README.md +++ b/README.md @@ -91,14 +91,14 @@ This project runs on community contributions. Whether you want to write new scri ### Where to start -| I want to… | Go here | -| ------------------------------------------- | ------------------------------------------------------------------------- | -| 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) | +| I want to… | Go here | +| ------------------------------------- | ------------------------------------------------------------------------------------------------- | +| 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