5.2 KiB
Community Scripts Contribution Guide
Welcome to the communty-scripts Repository!
📜 These documents outlines the essential coding standards for all our scripts and JSON files. Adhering to these standards ensures that our codebase remains consistent, readable, and maintainable. By following these guidelines, we can improve collaboration, reduce errors, and enhance the overall quality of our project.
Why Coding Standards Matter
Coding standards are crucial for several reasons:
- Consistency: Consistent code is easier to read, understand, and maintain. It helps new team members quickly get up to speed and reduces the learning curve.
- Readability: Clear and well-structured code is easier to debug and extend. It allows developers to quickly identify and fix issues.
- 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.
- 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 documentes covers the coding standards for the following types of files in our project:
APP-install.shScripts: These scripts are responsible for the installation of applications and are located in the/installdirectory.APP.shScripts: These scripts handle the creation and updating of containers and are found in the/ctdirectory.- JSON Files: These files store structured data and are located in the
/jsondirectory.
Each section provides detailed guidelines on various aspects of coding, including shebang usage, comments, variable naming, function naming, indentation, error handling, command substitution, quoting, script structure, and logging. Additionally, examples are provided to illustrate the application of these standards.
By following the coding standards outlined in this document, we ensure that our scripts and JSON files are of high quality, making our project more robust and easier to manage. Please refer to this guide whenever you create or update scripts and JSON files to maintain a high standard of code quality across the project. 📚🔍
Let's work together to keep our codebase clean, efficient, and maintainable! 💪🚀
Getting Started
Before contributing, please ensure that you have the following setup:
- Visual Studio Code (recommended for script development)
- Necessary VS Code Extensions:
Important Notes
- Use AppName.sh and AppName-install.sh as templates when creating new scripts.
- The call to
community-scripts/ProxmoxVEshould be adjusted to reflect the correct fork URL.
🚀 The Application Script (ct/AppName.sh)
- You can find all Coding standards, as well as the structure for this files here.
- These Scripts are responsible for Container creataion, setting the necessery varibles and handels the update of the Application.
🛠 The Installation Script (install/AppName-install.sh)
- You can find all Coding standards, as well as the structure for this files here.
- These Scripts are responsible for the installation of the Application.
🚀 Building Your Own Scripts
Start with the template script
🤝 Contribution Process
1. Fork the Repository
Fork to your GitHub account
2. Clone Your Fork on your Pc
git clone https://github.com/yourUserName/ForkName
3. Create a New Branch
git switch -c your-feature-branch
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!)
git commit -m "Your commit message"
5. Push to Your Fork
git push origin your-feature-branch
6. Create a Pull Request
Open a PR from your feature branch to the main repository branch