46 lines (31 loc) · 1.13 KB

Contributing

Thanks for your interest in improving the Klever installer.

Getting Started

git clone https://github.com/klever-io/install.git
cd install

Making Changes

Installer script (`install.sh`)

Must be compatible with bash 3.2+ (macOS default)
Must be idempotent, non-interactive, and require no root access
Run bash -n install.sh to verify syntax
Run shellcheck install.sh before submitting

Landing page (`index.html`)

Single self-contained file (no external dependencies)
Must work on mobile and desktop

Submitting a Pull Request

Fork the repository
Create a feature branch from develop
Make your changes
Ensure CI passes (ShellCheck, syntax check, dry run)
Open a PR against develop

Code Style

4-space indentation for shell scripts and HTML
Use local for all function variables in bash
Separate declaration and assignment for variables used in exit code checks

Reporting Issues

Open an issue on GitHub with:

Your OS and architecture
The full terminal output of the installer
What you expected to happen