From 66bc2bcfc217d70440cbf6a01f7f3dfd7cc785ee Mon Sep 17 00:00:00 2001 From: Michel Roegl-Brunner <73236783+michelroegl-brunner@users.noreply.github.com> Date: Wed, 25 Mar 2026 13:46:01 +0100 Subject: [PATCH] Revise contributing guidelines and remove outdated info Updated the contributing guidelines for clarity and conciseness. --- .../CONTRIBUTOR_AND_GUIDES/CONTRIBUTING.md | 78 +------------------ 1 file changed, 2 insertions(+), 76 deletions(-) diff --git a/.github/CONTRIBUTOR_AND_GUIDES/CONTRIBUTING.md b/.github/CONTRIBUTOR_AND_GUIDES/CONTRIBUTING.md index 1c5f20b5..a34d405f 100644 --- a/.github/CONTRIBUTOR_AND_GUIDES/CONTRIBUTING.md +++ b/.github/CONTRIBUTOR_AND_GUIDES/CONTRIBUTING.md @@ -14,9 +14,7 @@ Coding standards are crucial for several reasons: 3. **Maintainability**: Code that follows a standard structure is easier to refactor and update. It ensures that changes can be made with minimal risk of introducing new bugs. 4. **Collaboration**: When everyone follows the same standards, it becomes easier to collaborate on code. It reduces friction and misunderstandings during code reviews and merges. -### Scope of These Documents - -These documents cover the coding standards for the following types of files in our project: +### Scope of These Docs - **`install/$AppName-install.sh` Scripts**: These scripts are responsible for the installation of applications. - **`ct/$AppName.sh` Scripts**: These scripts handle the creation and updating of containers. @@ -31,76 +29,4 @@ Let's work together to keep our codebase clean, efficient, and maintainable! ## Getting Started -Before contributing, please ensure that you have the following setup: - -1. **Visual Studio Code** (recommended for script development) -2. **Recommended VS Code Extensions:** - - [Shell Syntax](https://marketplace.visualstudio.com/items?itemName=bmalehorn.shell-syntax) - - [ShellCheck](https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck) - - [Shell Format](https://marketplace.visualstudio.com/items?itemName=foxundermoon.shell-format) - -### Important Notes -- Use [AppName.sh](https://github.com/community-scripts/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.sh) and [AppName-install.sh](https://github.com/community-scripts/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.sh) as templates when creating new scripts. - ---- - -# 🚀 The Application Script (ct/AppName.sh) - -- You can find all coding standards, as well as the structure for this file [here](https://github.com/community-scripts/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.md). -- These scripts are responsible for container creation, setting the necessary variables and handling the update of the application once installed. - ---- - -# 🛠 The Installation Script (install/AppName-install.sh) - -- You can find all coding standards, as well as the structure for this file [here](https://github.com/community-scripts/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.md). -- These scripts are responsible for the installation of the application. - ---- - -## 🚀 Building Your Own Scripts - -Start with the [template script](https://github.com/community-scripts/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.sh) - ---- - -## 🤝 Contribution Process - -### 1. Fork the repository -Fork to your GitHub account - -### 2. Clone your fork on your local environment -```bash -git clone https://github.com/yourUserName/ForkName -``` - -### 3. Create a new branch -```bash -git switch -c your-feature-branch -``` - -### 4. Change paths in build.func install.func and AppName.sh -To be able to develop from your own branch you need to change `https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main` to `https://raw.githubusercontent.com/[USER]/[REPOSITORY]/refs/heads/[BRANCH]`. You need to make this change atleast in misc/build.func misc/install.func and in your ct/AppName.sh. This change is only for testing. Before opening a Pull Request you should change this line change all this back to point to `https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main`. - -### 4. Commit changes (without build.func and install.func!) -```bash -git commit -m "Your commit message" -``` - -### 5. Push to your fork -```bash -git push origin your-feature-branch -``` - -### 6. Create a Pull Request -Open a Pull Request from your feature branch to the main repository branch. You must only include your **$AppName.sh**, **$AppName-install.sh** and **$AppName.json** files in the pull request. - ---- - -## 📚 Pages - -- [CT Template: AppName.sh](https://github.com/community-scripts/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.sh) -- [Install Template: AppName-install.sh](https://github.com/community-scripts/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.sh) -- [JSON Template: AppName.json](https://github.com/community-scripts/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/json/AppName.json) - - +Find all needed Information in our [Docs]([https://duckduckgo.com](https://community-scripts.org/docs)