Thank you for your interest in contributing to the project! As this is a personal demo project, contributions, though less formal than in larger projects, are still very much appreciated. Here's a quick guide on how you can contribute effectively.
First, you'll need to have a basic setup running:
-
Clone the repository: Start by cloning the repository to get your own local copy.
git clone https://github.com/yourusername/telepresence-demo.git cd telepresence-demo -
Follow the setup instructions: Refer to the README.md to set up Minikube and install all necessary dependencies.
Feel free to make changes or improvements that you see fit. Here's how you can do it:
-
Create a new branch for your modifications:
git checkout -b feature/your-feature-name
-
Make your changes locally. After you've made changes, commit them:
git add . git commit -m "Describe the change or enhancement"
-
Push your branch to your fork:
git push origin feature/your-feature-name
-
Open a pull request with a detailed description of what your changes do and why you think they should be included.
If you have suggestions or find bugs:
- Open an issue describing the bug or enhancement in detail, and how it might improve the project.
Please test any changes or additions rigorously to ensure functionality and that existing features are not adversely affected.
- Ensure that your code is tidy.
- Update the README.md with details of changes to the interface or environment setup if necessary.
- You may merge the Pull Request once you have the sign-off of other collaborators, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
By contributing, you agree that your contributions will be licensed under its MIT License.
This guide aims to keep things straightforward. Your contributions help make this demo more useful and educational for others exploring similar technologies!