community-scripts/Proxmox
2
0
Fork 0
mirror of https://github.com/community-scripts/Proxmox.git synced 2026-04-20 08:59:06 -05:00
Code Issues 1 Packages Projects Releases Wiki Activity

Merge pull request #36 from BramSuurdje/edit-readme

Browse Source 
Edit readme
This commit is contained in:
Bram Suurd
2024-07-27 20:16:07 +02:00
committed by GitHub
parent 8a5c2dce35 d351c63187
commit 7eec5fa1b2
2 changed files with 76 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,43 @@
# Contributing to the Proxmox VE Helper Scripts Website Re-Design
A big welcome and thank you for considering contributing to the Proxmox VE Helper Scripts Website Re-Design! It’s people like you that make it a reality for users in our community.
Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.
## Quicklinks
* [Getting Started](#getting-started)
* [Issues](#issues)
* [Pull Requests](#pull-requests)
## Getting Started
Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:
- Search for existing Issues and PRs before creating your own.
- We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.
### Issues
Issues should be used to report problems with the website, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.
If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) can also help indicate to our maintainers that a particular problem is affecting more than just the reporter.
### Pull Requests
PRs to my website are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:
- Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both.
- Address a single concern in the least number of changed lines as possible.
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr)
1. Fork the repository to your own Github account
2. Clone the project to your machine
3. Create a branch locally with a succinct but descriptive name
4. Commit changes to the branch
5. Following any formatting and testing guidelines specific to this repo
6. Push changes to your fork
7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.

48
README.md
View File

@@ -1,21 +1,39 @@
# Proxmox Helper Scripts
<h1 align="center">
<a href="https://proxmox-helper-scripts.vercel.app" target="_blank"><img src="https://github.com/user-attachments/assets/159b930c-83b9-4732-bbf6-b9ddcd8616bb" alt="Proxmox Helper Scripts" width="800"></a>
</h1>
re-design of the [Proxmox VE helper-script website](https://helper-scripts.com) .
<p align="center">
<a href="https://github.com/BramSuurdje/proxmox-helper-scripts/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/BramSuurdje/proxmox-helper-scripts?style=for-the-badge&logo=github&color=1A91FF"/></a>
<a href="https://github.com/BramSuurdje/proxmox-helper-scripts/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/BramSuurdje/proxmox-helper-scripts?style=for-the-badge&color=1A91FF" /></a>
</p>
Feel free to fork the project or post feedback in the [Discussion tab](https://github.com/BramSuurdje/proxmox-helper-scripts/discussions). Your feedback is always welcome.
<p align="center">Redesign of the Proxmox VE Helper Scripts website. optimized for readablity and security</p>
## How to Contribute
> [!WARNING]
> always check the source code of the scripts before running them. Copying random scripts without understanding what they do can lead to data loss or other security issues.
First, install the dependencies:
> [!NOTE]
> This website is not affiliated with the Proxmox VE Helper Scripts repository. This website is simply a redesign of the original website, with a focus on readability and security.
```bash
npm install
# or
yarn install
# or
pnpm install
# or
bun install
```
## 👀 Why even use the Re-design?
then, Open [http://localhost:3000](http://localhost:3000) in your browser to see the result.
### Overview
This repository contains a collection of helper scripts for Proxmox VE, designed to enhance and simplify the user experience. The scripts include various functionalities such as easier access to source code for improved security and a redesigned website for better script viewing.
### Features
- **Script Source Access**: Easily access the source code of each script to review and enhance security.
- **Redesigned Website**: Improved layout for easier script viewing.
## Getting Started
### Prerequisites
- Proxmox VE installed
### Contributing
Contributions are welcome! Please read the [contributing guidelines](CONTRIBUTING.md) for more information.
### License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
### Contact
For questions or support, please open an issue on GitHub.