From bb3077a8c6835b595cf3be41ae8e2ed0117c1db9 Mon Sep 17 00:00:00 2001 From: CanbiZ <47820557+MickLesk@users.noreply.github.com> Date: Fri, 6 Dec 2024 14:24:38 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- .github/CONTRIBUTOR_GUIDE/CONTRIBUTING.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/.github/CONTRIBUTOR_GUIDE/CONTRIBUTING.md b/.github/CONTRIBUTOR_GUIDE/CONTRIBUTING.md index 8b815b2f..39efc6c3 100644 --- a/.github/CONTRIBUTOR_GUIDE/CONTRIBUTING.md +++ b/.github/CONTRIBUTOR_GUIDE/CONTRIBUTING.md @@ -148,7 +148,7 @@ echo -e "${TAB}${GATEWAY}${BGN}http://${IP}:[PORT]${CL}" - `build_container`: Collects and integrates user settings - `description`: Sets LXC container description -I'll convert the remaining document to a GitHub-flavored Markdown with emojis and improved formatting: +--- # 🛠 Structure of Installation Scripts (install/AppName-install.sh) @@ -231,12 +231,14 @@ $STD apt-get -y autoclean msg_ok "Cleaned" ``` + + ## 7. 📢 Progress Messages ```bash -msg_info "Starting task" +msg_info "Setup ${APPLICATION}" $STD some_command -msg_ok "Task completed" +msg_ok "Setup ${APPLICATION}" ``` ## 8. 🏷️ Version Tracking @@ -301,7 +303,7 @@ Fork to your GitHub account ### 2. Clone Your Fork ```bash -git clone https://github.com/YOUR_USERNAME/community-scripts.git +git clone https://github.com/community-scripts/ProxmoxVE ``` ### 3. Create a New Branch @@ -309,7 +311,10 @@ git clone https://github.com/YOUR_USERNAME/community-scripts.git git checkout -b your-feature-branch ``` -### 4. Commit Changes +### 4. Change Paths in build.func and install.func +you need to switch "community-scripts/ProxmoxVE" to "yourUserName/ForkName" + +### 4. Commit Changes (without build.func and install.func!) ```bash git commit -m "Your commit message" ```