martin/ProxmoxVE
1
0
Fork 0
mirror of https://github.com/community-scripts/ProxmoxVE synced 2025-02-11 02:09:17 +00:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

Fixed typos in CONTRIBUTOR_GUIDE (#2174)

Browse Source 
Co-authored-by: thomashondema <thomas.hondema@icepay.com>
This commit is contained in:
thomashondema 2025-02-08 23:37:35 +01:00 committed by GitHub
parent f69d5b5831
commit 8fd8ca2c50
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.github/CONTRIBUTOR_GUIDE/ct/AppName.md vendored
View File

@ -171,7 +171,7 @@ if [[ ! -d /opt/snipe-it ]]; then
### 3.3 **Check version** ### 3.3 **Check version**
- Befoer updating, check if a new version exists. - Before updating, check if a new version exists.
- We use the `${APPLICATION}_version.txt` file created in `/opt` during the install to compare new versions against the currently installed version. - We use the `${APPLICATION}_version.txt` file created in `/opt` during the install to compare new versions against the currently installed version.
Example with a Github Release: Example with a Github Release:
@ -241,7 +241,7 @@ Example:
### 3.7 **No update function** ### 3.7 **No update function**
- In case you can not provide a update function use the following code to provide user feedback. - In case you can not provide an update function use the following code to provide user feedback.
```bash ```bash
function update_script() { function update_script() {
@ -252,7 +252,7 @@ function update_script() {
msg_error "No ${APP} Installation Found!" msg_error "No ${APP} Installation Found!"
exit exit
fi fi
msg_error "Ther is currently no automatic update function for ${APP}." msg_error "There is currently no automatic update function for ${APP}."
exit exit
} }
``` ```
@ -286,6 +286,6 @@ echo -e "${TAB}${GATEWAY}${BGN}http://${IP}${CL}"
- [ ] Metadata (author, license) is included at the top. - [ ] Metadata (author, license) is included at the top.
- [ ] Variables follow naming conventions. - [ ] Variables follow naming conventions.
- [ ] Update function exists. - [ ] Update function exists.
- [ ] Update functions checks if app is installed an for new version. - [ ] Update functions checks if app is installed and for new version.
- [ ] Update function up temporary files. - [ ] Update function cleans up temporary files.
- [ ] Script ends with a helpful message for the user to reach the application. - [ ] Script ends with a helpful message for the user to reach the application.

2
.github/CONTRIBUTOR_GUIDE/json/AppName.json vendored
View File

@ -12,7 +12,7 @@
"documentation": null, "documentation": null,
"website": "LINK TO WEBSITE", "website": "LINK TO WEBSITE",
"logo": "LINK TO LOGO", "logo": "LINK TO LOGO",
"description": "Deescription of the app", "description": "Description of the app",
"install_methods": [ "install_methods": [
{ {
"type": "default", "type": "default",