From 4d4e3806e5d7f4ec311f538395ad9ec8015e7cb9 Mon Sep 17 00:00:00 2001 From: Bram Suurd <78373894+BramSuurdje@users.noreply.github.com> Date: Sat, 27 Jul 2024 20:02:25 +0200 Subject: [PATCH 1/6] re-did the readme for better readablity and added a contribution guide --- CONTRIBUTING.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 45 ++++++++++++++++++++++++++++++--------------- 2 files changed, 74 insertions(+), 15 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4f18852 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,44 @@ +# Contributing to Proxmox VE Helper Scripts + +A big welcome and thank you for considering contributing to Proxmox VE Helper Scripts open source projects! 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 Help](#getting-help) + +## 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. \ No newline at end of file diff --git a/README.md b/README.md index 178a09b..5a0ec0f 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,36 @@ -# Proxmox Helper Scripts +

+ Proxmox Helper Scripts +

-re-design of the [Proxmox VE helper-script website](https://helper-scripts.com) . +

+ License + Contributors +

-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. +

Redesign of the [Proxmox VE Helper Scripts website](https://tteck.github.io/Proxmox/). optimized for readablity and security

-## 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: +## 👀 Why even use the Re-design? -```bash -npm install -# or -yarn install -# or -pnpm install -# or -bun install -``` +### 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. -then, Open [http://localhost:3000](http://localhost:3000) in your browser to see the result. +### 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. \ No newline at end of file From 99153854221e832ac61b33daf28029a436e58baa Mon Sep 17 00:00:00 2001 From: Bram Suurd <78373894+BramSuurdje@users.noreply.github.com> Date: Sat, 27 Jul 2024 11:03:33 -0700 Subject: [PATCH 2/6] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5a0ec0f..8c07d5d 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Contributors

-

Redesign of the [Proxmox VE Helper Scripts website](https://tteck.github.io/Proxmox/). optimized for readablity and security

+

Redesign of the [Proxmox VE Helper Scripts website](https://tteck.github.io/Proxmox/) . optimized for readablity and security

[!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. @@ -33,4 +33,4 @@ Contributions are welcome! Please read the [contributing guidelines](CONTRIBUTIN 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. \ No newline at end of file +For questions or support, please open an issue on GitHub. From 06f328ecc8603bccc5d7c0ed31c9d466218be681 Mon Sep 17 00:00:00 2001 From: Bram Suurd <78373894+BramSuurdje@users.noreply.github.com> Date: Sat, 27 Jul 2024 11:04:16 -0700 Subject: [PATCH 3/6] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8c07d5d..49bf169 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,8 @@

Redesign of the [Proxmox VE Helper Scripts website](https://tteck.github.io/Proxmox/) . optimized for readablity and security

-[!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. +> [!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. ## 👀 Why even use the Re-design? From 6a1b71dbb00c215d28e63b43a6b98fb73b7298bc Mon Sep 17 00:00:00 2001 From: Bram Suurd <78373894+BramSuurdje@users.noreply.github.com> Date: Sat, 27 Jul 2024 11:14:00 -0700 Subject: [PATCH 4/6] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 49bf169..ec3789a 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,14 @@ Contributors

-

Redesign of the [Proxmox VE Helper Scripts website](https://tteck.github.io/Proxmox/) . optimized for readablity and security

+

Redesign of the Proxmox VE Helper Scripts website. optimized for readablity and security

> [!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. +> [!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. + ## 👀 Why even use the Re-design? ### Overview From 43a5dc831a8c28b964170806e94dd1dbf2ea7e48 Mon Sep 17 00:00:00 2001 From: Bram Suurd <78373894+BramSuurdje@users.noreply.github.com> Date: Sat, 27 Jul 2024 11:14:56 -0700 Subject: [PATCH 5/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4f18852..80a097e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contributing to Proxmox VE Helper Scripts +# Contributing to the Proxmox VE Helper Scripts Website Re-Design -A big welcome and thank you for considering contributing to Proxmox VE Helper Scripts open source projects! It’s people like you that make it a reality for users in our community. +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. @@ -41,4 +41,4 @@ In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susa 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. \ No newline at end of file +7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes. From d351c631875a5ff2edf2e96dfe479a41d2915c75 Mon Sep 17 00:00:00 2001 From: Bram Suurd <78373894+BramSuurdje@users.noreply.github.com> Date: Sat, 27 Jul 2024 11:15:07 -0700 Subject: [PATCH 6/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 80a097e..9dfdcc4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,6 @@ Reading and following these guidelines will help us make the contribution proces * [Getting Started](#getting-started) * [Issues](#issues) * [Pull Requests](#pull-requests) -* [Getting Help](#getting-help) ## Getting Started