martin/ProxmoxVE
1
0
Fork 0
mirror of https://github.com/community-scripts/ProxmoxVE synced 2025-01-10 19:05:09 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Fixing some typos

Browse Source
This commit is contained in:
Rémi Bédard-Couture 2024-12-22 17:28:23 -05:00 committed by GitHub
parent 4dc7a3df0d
commit acd26c4747
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
.github/CONTRIBUTOR_GUIDE/CONTRIBUTING.md vendored
View File

@ -15,7 +15,7 @@ Coding standards are crucial for several reasons:
### Scope of These Documents ### Scope of These Documents
These documentes covers the coding standards for the following types of files in our project: These documents covers the coding standards for the following types of files in our project:
- **`APP-install.sh` Scripts**: These scripts are responsible for the installation of applications and are located in the `/install` directory. - **`APP-install.sh` Scripts**: These scripts are responsible for the installation of applications and are located in the `/install` directory.
- **`APP.sh` Scripts**: These scripts handle the creation and updating of containers and are found in the `/ct` directory. - **`APP.sh` Scripts**: These scripts handle the creation and updating of containers and are found in the `/ct` directory.
@ -33,7 +33,7 @@ Let's work together to keep our codebase clean, efficient, and maintainable!
Before contributing, please ensure that you have the following setup: Before contributing, please ensure that you have the following setup:
1. **Visual Studio Code** (recommended for script development) 1. **Visual Studio Code** (recommended for script development)
2. **Necessary VS Code Extensions:** 2. **Recommended VS Code Extensions:**
- [Shell Syntax](https://marketplace.visualstudio.com/items?itemName=bmalehorn.shell-syntax) - [Shell Syntax](https://marketplace.visualstudio.com/items?itemName=bmalehorn.shell-syntax)
- [ShellCheck](https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck) - [ShellCheck](https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck)
- [Shell Format](https://marketplace.visualstudio.com/items?itemName=foxundermoon.shell-format) - [Shell Format](https://marketplace.visualstudio.com/items?itemName=foxundermoon.shell-format)
@ -46,15 +46,15 @@ Before contributing, please ensure that you have the following setup:
# 🚀 The Application Script (ct/AppName.sh) # 🚀 The Application Script (ct/AppName.sh)
- You can find all Coding standards, as well as the structure for this files [here](https://github.com/community-scripts/ProxmoxVE/blob/contributor_guide/.github/CONTRIBUTOR_GUIDE/ct/AppName.md). - You can find all coding standards, as well as the structure for this files [here](https://github.com/community-scripts/ProxmoxVE/blob/contributor_guide/.github/CONTRIBUTOR_GUIDE/ct/AppName.md).
- These Scripts are responsible for Container creataion, setting the necessery varibles and handels the update of the Application. - These Scripts are responsible for container creation, setting the necessary variables and handles the update of the application.
--- ---
# 🛠 The Installation Script (install/AppName-install.sh) # 🛠 The Installation Script (install/AppName-install.sh)
- You can find all Coding standards, as well as the structure for this files [here](https://github.com/community-scripts/ProxmoxVE/blob/contributor_guide/.github/CONTRIBUTOR_GUIDE/install/AppName-install.md). - You can find all coding standards, as well as the structure for this files [here](https://github.com/community-scripts/ProxmoxVE/blob/contributor_guide/.github/CONTRIBUTOR_GUIDE/install/AppName-install.md).
- These Scripts are responsible for the installation of the Application. - These scripts are responsible for the installation of the application.
--- ---
@ -80,7 +80,7 @@ git switch -c your-feature-branch
``` ```
### 4. Change Paths in build.func install.func and AppName.sh ### 4. Change Paths in build.func install.func and AppName.sh
You need to switch `https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main` to `https://raw.githubusercontent.com/[USER]/[REPOSITORY]/refs/head/[BRANCH]` to test your script in your repository. Befor opening a Pull Request change all this back to point to the community-scripts Repository. You need to switch `https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main` to `https://raw.githubusercontent.com/[USER]/[REPOSITORY]/refs/head/[BRANCH]` to test your script in your repository. Before opening a Pull Request change all this back to point to the community-scripts Repository.
### 4. Commit Changes (without build.func and install.func!) ### 4. Commit Changes (without build.func and install.func!)
```bash ```bash