Development Documentation
Guides for setting up a development environment and contributing to the Zer0-Mistakes theme.
Contents
| Document |
Description |
| Local Setup |
Set up your development environment |
| Testing |
Run tests and validate changes |
| Code Style |
Coding conventions and best practices |
Quick Start
# Clone the repository
git clone https://github.com/bamr87/zer0-mistakes.git
cd zer0-mistakes
# Start development server
docker-compose up
# Open http://localhost:4000
Prerequisites
- Docker Desktop — For containerized development
- Git — For version control
- Text Editor — VS Code recommended
Development Workflow
- Fork/clone the repository
- Create a branch for your changes
- Make changes and test locally
- Run tests to validate
- Submit PR with description
Key Files
| File |
Purpose |
_config.yml |
Production configuration |
_config_dev.yml |
Development overrides |
docker-compose.yml |
Docker setup |
Gemfile |
Ruby dependencies |
Makefile |
Build shortcuts |
Testing
# Run preflight validation
./scripts/validate
# Run quick host-only validation
./scripts/validate --quick
# Run test suite
./scripts/bin/test
# Run specific tests
./test/test_runner.sh --suites core
# Lint check
make lint
Building the Gem
# Preview build
./scripts/build --dry-run
# Build gem
./scripts/build