[PR #4518] [MERGED] Updates to contributor docs/guide #4936

Closed
opened 2026-02-26 14:32:34 +03:00 by kerem · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/community-scripts/ProxmoxVE/pull/4518
Author: @tremor021
Created: 5/15/2025
Status: Merged
Merged: 5/16/2025
Merged by: @MickLesk

Base: mainHead: contrib


📝 Commits (1)

📊 Changes

4 files changed (+69 additions, -71 deletions)

View changed files

📝 .github/CONTRIBUTOR_AND_GUIDES/ct/AppName.md (+7 -7)
📝 .github/CONTRIBUTOR_AND_GUIDES/ct/AppName.sh (+47 -47)
📝 .github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.md (+2 -2)
📝 .github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.sh (+13 -15)

📄 Description

✍️ Description

  • Updated AppName.md to include new format of default container vars
  • Updated AppName.sh to include new format of default container vars and moved comments on top of the line it refers to, as in the rest of the docs
  • Updated AppName-install.md to use curl -fsSL in code examples instead of wget
  • Updated AppName-install.sh with some code cleanup and formatting

Link: #

Prerequisites (X in brackets)

  • Self-review completed – Code follows project standards.
  • Tested thoroughly – Changes work as expected.
  • No security risks – No hardcoded secrets, unnecessary privilege escalations, or permission issues.

🛠️ Type of Change (X in brackets)

  • 🐞 Bug fix – Resolves an issue without breaking functionality.
  • New feature – Adds new, non-breaking functionality.
  • 💥 Breaking change – Alters existing functionality in a way that may require updates.
  • 🆕 New script – A fully functional and tested script or script set.
  • 🌍 Website update – Changes to website-related JSON files or metadata.
  • 🔧 Refactoring / Code Cleanup – Improves readability or maintainability without changing functionality.
  • 📝 Documentation update – Changes to README, AppName.md, CONTRIBUTING.md, or other docs.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/community-scripts/ProxmoxVE/pull/4518 **Author:** [@tremor021](https://github.com/tremor021) **Created:** 5/15/2025 **Status:** ✅ Merged **Merged:** 5/16/2025 **Merged by:** [@MickLesk](https://github.com/MickLesk) **Base:** `main` ← **Head:** `contrib` --- ### 📝 Commits (1) - [`e87c1b7`](https://github.com/community-scripts/ProxmoxVE/commit/e87c1b74c2de400d15093cb69672fe9435022cac) Updated contributor docs ### 📊 Changes **4 files changed** (+69 additions, -71 deletions) <details> <summary>View changed files</summary> 📝 `.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.md` (+7 -7) 📝 `.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.sh` (+47 -47) 📝 `.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.md` (+2 -2) 📝 `.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.sh` (+13 -15) </details> ### 📄 Description <!--🛑 New scripts must be submitted to [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) for testing. PRs without prior testing will be closed. --> ## ✍️ Description - Updated `AppName.md` to include new format of default container vars - Updated `AppName.sh` to include new format of default container vars and moved comments on top of the line it refers to, as in the rest of the docs - Updated `AppName-install.md` to use `curl -fsSL` in code examples instead of `wget` - Updated `AppName-install.sh` with some code cleanup and formatting ## 🔗 Related PR / Issue Link: # ## ✅ Prerequisites (**X** in brackets) - [x] **Self-review completed** – Code follows project standards. - [x] **Tested thoroughly** – Changes work as expected. - [x] **No security risks** – No hardcoded secrets, unnecessary privilege escalations, or permission issues. --- ## 🛠️ Type of Change (**X** in brackets) - [ ] 🐞 **Bug fix** – Resolves an issue without breaking functionality. - [ ] ✨ **New feature** – Adds new, non-breaking functionality. - [ ] 💥 **Breaking change** – Alters existing functionality in a way that may require updates. - [ ] 🆕 **New script** – A fully functional and tested script or script set. - [ ] 🌍 **Website update** – Changes to website-related JSON files or metadata. - [ ] 🔧 **Refactoring / Code Cleanup** – Improves readability or maintainability without changing functionality. - [x] 📝 **Documentation update** – Changes to `README`, `AppName.md`, `CONTRIBUTING.md`, or other docs. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
kerem 2026-02-26 14:32:34 +03:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/ProxmoxVE#4936
No description provided.