5fd2bc10f9
The Proxmox brand guidelines https://www.proxmox.com/images/proxmox/Proxmox-Corporate-Brandguideline-2018.pdf request that products are referred to by their full or abbreviated names. Honour this request by updating our usage of the word Proxmox to refer to Proxmox VE.
2.0 KiB
Contributing to Cluster API Provider for Proxmox Virtual Environment
Thank you for considering contributing to the Cluster API Provider for Proxmox VE. We appreciate your time and effort to help make this project better. To ensure a smooth collaboration, please follow the guidelines below.
Code of Conduct
This project follows the CNCF Code of Conduct. By participating, you are expected to uphold this code.
How to Contribute
- Fork the repository and create a new branch:
git clone https://github.com/your-username/cluster-api-provider-proxmox.git
cd cluster-api-provider-proxmox
git checkout -b feature-branch
- Make your changes and commit them:
git add .
git commit -m "Your meaningful commit message"
- Push your changes to your fork:
git push origin feature-branch
- Open a pull request:
- Provide a clear and descriptive title for your changes.
- Include details about the changes and the problem it solves.
- Reference any relevant issues or pull requests.
Development guide
For more in depth development documentation please check our development guide
Code Guidelines
- Write clear and concise code with meaningful variable and function names.
- Keep the code modular and well-documented.
- Ensure your code passes the existing tests.
Testing
Make sure to run the existing tests before submitting your contribution. If your contribution introduces new features, add appropriate tests to cover them.
make test
Documentation
Ensure that your changes are reflected in the documentation. If you are introducing new features, update the documentation accordingly.
Reporting Issues
If you encounter any issues or have suggestions for improvement, please open an issue on the GitHub repository.
Thank You
Thank you for your contribution! Your efforts help make the Cluster API Provider for Proxmox VE better for everyone. We appreciate your dedication to the project and the CNCF community.