Skip to content

Latest commit

 

History

History
129 lines (83 loc) · 6.42 KB

CONTRIBUTING.md

File metadata and controls

129 lines (83 loc) · 6.42 KB

Community Scripts Contribution Guide

Welcome to the communty-scripts Repository!

📜 These documents outline 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:

  1. 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.
  2. Readability: Clear and well-structured code is easier to debug and extend. It allows developers to quickly identify and fix issues.
  3. 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.
  4. 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 documents cover the coding standards for the following types of files in our project:

  • install/$AppName-install.sh Scripts: These scripts are responsible for the installation of applications.
  • ct/$AppName.sh Scripts: These scripts handle the creation and updating of containers.
  • json/$AppName.json: These files store structured data and are used for the website.

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:

  1. Visual Studio Code (recommended for script development)
  2. Recommended VS Code Extensions:

Important Notes

  • Use AppName.sh and 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.

🚀 The Application Script (ct/AppName.sh)

  • You can find all coding standards, as well as the structure for this file here.
  • These scripts are responsible for container creation, setting the necessary variables and handling the update of the application once installed.

🛠 The Installation Script (install/AppName-install.sh)

  • You can find all coding standards, as well as the structure for this file here.
  • These scripts are responsible for the installation of the application.

🚀 Building Your Own Scripts

Start with the template script

🤝 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

2. Clone your fork on your local environment

git clone https://github.com/yourUserName/ForkName

3. Create a new branch

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]
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!)

git commit -m "Your commit message"

5. Push to your fork

git push origin your-feature-branch

6. Create a 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.

📚 Pages