diff --git a/.github/CONTRIBUTOR_AND_GUIDES/CONTRIBUTING.md b/.github/CONTRIBUTOR_AND_GUIDES/CONTRIBUTING.md index f5a46fcd1..ff317425a 100644 --- a/.github/CONTRIBUTOR_AND_GUIDES/CONTRIBUTING.md +++ b/.github/CONTRIBUTOR_AND_GUIDES/CONTRIBUTING.md @@ -40,7 +40,7 @@ Before contributing, please ensure that you have the following setup: - [Shell Format](https://marketplace.visualstudio.com/items?itemName=foxundermoon.shell-format) ### Important Notes -- Use [AppName.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.sh) and [AppName-install.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.sh) as templates when creating new scripts. +- Use [AppName.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.sh) and [AppName-install.sh](https://github.com/community-scripts/ProxmoxVE/blob/main/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.sh) as templates when creating new scripts. Final version of the script (the one you will push for review), must have all comments removed, except the ones in the file header. --- @@ -66,6 +66,12 @@ Start with the [template script](https://github.com/community-scripts/ProxmoxVE/ ## 🤝 Contribution Process +All PR's related to new scripts should be made against our Dev repository first, where we can test the scripts before they are pushed and merged in the official repository. + +**Our Dev repo is `http://www.github.com/community-scripts/ProxmoxVED`** + +You will need to adjust paths mentioned further down this document to match the repo you're pushing the scripts to. + ### 1. Fork the repository Fork to your GitHub account @@ -80,7 +86,24 @@ 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/ProxmoxVE/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/ProxmoxVE/main`. +To be able to develop from your own branch you need to change:\ +`https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main`\ +to\ +`https://raw.githubusercontent.com/[USER]/[REPOSITORY]/refs/heads/[BRANCH]`\ + in following files: + +`misc/build.func`\ +`misc/install.func`\ +`ct/AppName.sh` + +Example: `https://raw.githubusercontent.com/tremor021/PromoxVE/refs/heads/testbranch` + +Also you need to change:\ +`https://github.com/community-scripts/ProxmoxVE/raw/main`\ +to\ +`https://github.com/[USER]/[REPOSITORY]/raw/[BRANCH]`\ +in `misc/install.func` in order for `update` shell command to work.\ +These changes are only while writing and testing your scripts. Before opening a Pull Request, you should change all above mentioned paths in `misc/build.func`, `misc/install.func` and `ct/AppName.sh` to point to the original paths. ### 4. Commit changes (without build.func and install.func!) ```bash @@ -93,7 +116,7 @@ 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. +Open a Pull Request from your feature branch to the main branch on the Dev repository. You must only include your **$AppName.sh**, **$AppName-install.sh** and **$AppName.json** files in the pull request. --- diff --git a/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.md b/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.md index be6c6f848..e3a2b0bc0 100644 --- a/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.md +++ b/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.md @@ -75,6 +75,7 @@ Example: > > - Add your username and source URL > - For existing scripts, add "| Co-Author [YourUserName]" after the current author +> - Source is a URL of github repo containting source files of the application you're installing (not URL of your homepage or a blog) --- @@ -95,7 +96,7 @@ Example: >| Variable | Description | Notes | >|----------|-------------|-------| >| `APP` | Application name | Must match ct\AppName.sh | ->| `var_tags` | Proxmox display tags without Spaces, only ; | Limit the number | +>| `var_tags` | Proxmox display tags without Spaces, only ; | Limit the number to 2 | >| `var_cpu` | CPU cores | Number of cores | >| `var_ram` | RAM | In MB | >| `var_disk` | Disk capacity | In GB | diff --git a/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.md b/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.md index 241cd99ac..d2b65e025 100644 --- a/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.md +++ b/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.md @@ -67,6 +67,7 @@ Example: > > - Add your username > - When updating/reworking scripts, add "| Co-Author [YourUserName]" +> - Source is a URL of github repo containting source files of the application you're installing (not URL of your homepage or a blog) ### 1.3 **Variables and function import** @@ -177,6 +178,7 @@ echo "${RELEASE}" >"/opt/AppName_version.txt" - Use standard functions like `msg_info`, `msg_ok` or `msg_error` to print status messages. - Each `msg_info` must be followed with a `msg_ok` before any other output is made. - Display meaningful progress messages at key stages. +- Taking user input with `read -p` must be outside of `msg_info`...`msg_ok` code block Example: @@ -184,6 +186,8 @@ Example: msg_info "Installing Dependencies" $STD apt-get install -y ... msg_ok "Installed Dependencies" + +read -p "Do you wish to enable HTTPS mode? (y/N): " httpschoice ``` ### 6.2 **Verbosity**