diff --git a/3.-Contributing.md b/3.-Contributing.md deleted file mode 100644 index 932f5e6..0000000 --- a/3.-Contributing.md +++ /dev/null @@ -1,39 +0,0 @@ -# Contributing to the Project - -We are excited to have you contribute to the community-scripts repository! Here’s everything you need to know about contributing to this project. - -## Steps to Contribute: -1. **Fork the repository**: Click the "Fork" button at the top right of the page to create a copy of the repository in your own GitHub account. - -2. **Clone your fork**: - ```bash - git clone https://github.com/your-username/ProxmoxVE.git - cd ProxmoxVE - ``` - -3. **Create a new branch** for your work: - ```bash - git checkout -b my-feature-branch - ``` - -4. **Make changes**: Add your features, fixes, or improvements to the scripts. Ensure you follow the coding standards outlined in the [Coding Standards](docs/coding-standards.md) page. - -5. **Test your changes**: Run your script and make sure everything works as expected. If applicable, write tests and make sure they pass. - -6. **Commit your changes**: - ```bash - git add . - git commit -m "Description of your changes" - ``` - -7. **Push your changes** to your fork: - ```bash - git push origin my-feature-branch - ``` - -8. **Submit a Pull Request**: Open a pull request on the original repository. Be sure to provide a detailed description of what your changes do. - -## Pull Request Guidelines: -- Ensure that your pull request targets the **main branch** unless specified otherwise. -- Describe the **problem** you're solving or the **feature** you're adding in the pull request description. -- Include relevant details on **testing** that you performed, including commands and expected results.