Contributing to Playpen

Thank you for your interest in contributing to Playpen! We welcome contributions from the community to help make this the best local platform simulator for everyone.

Getting Started

1. Fork the repository on GitHub.
2. Clone your fork locally:

   git clone https://github.com/hiranofficial/playpen.git
   cd playpen
   

3. Install Prerequisites: Ensure you have Docker, Helm, and Kubectl installed (see README.md).

Development Workflow

1. Create a Branch:

   git checkout -b feature/my-new-feature
   

2. Make Changes:
   • Infrastructure changes go into charts/playpen.
   • Documentation changes go into docs/.
3. Verify:
   • Run helm lint charts/playpen to check your chart changes.
   • Run ./scripts/verify.sh after installing to ensure nothing broke.
4. Commit: Use clear and descriptive commit messages.

submitting a Pull Request

1. Push your branch to your fork.
2. Open a Pull Request against the main branch of the official repository.
3. Describe your changes and why they are needed.

License

By contributing, you agree that your contributions will be licensed under the project's MIT License.