Development
Developer guides for contributing to and extending the Zer0-Mistakes Jekyll theme.
Table of Contents
Contributing to Zer0-Mistakes
This section provides guides for theme contributors — developers who want to contribute to, extend, or modify the Zer0-Mistakes Jekyll theme itself.
Deep technical reference (architecture, scripts, systems, release automation internals) lives in the
docs/directory in the repository. This section provides the contributor-accessible overview; thedocs/directory has the full technical reference.
Getting Started
Before contributing, ensure you have:
- Docker Desktop installed (recommended)
- Git configured with SSH keys
- Basic understanding of Jekyll and Ruby
Developer Guides
Build & Release
| Guide | Description |
|---|---|
| Release Management | Semantic versioning, changelog management, and gem publishing |
| Version Bump | Automated version bumping workflow |
| CI/CD Pipeline | Continuous integration and deployment workflows |
Quality & Security
| Guide | Description |
|---|---|
| Testing | Test suite structure and development standards |
| Security | CodeQL scanning and security best practices |
| Dependency Updates | Automated dependency management |
Documentation & Tooling
| Guide | Description |
|---|---|
| Documentation | Dual documentation architecture and workflow |
| Scripts | Shell script automation library |
| PRD | Product requirements document |
Quick Commands
# Run all tests
./test/test_runner.sh
# Build the gem
./scripts/build.sh
# Create a release
./scripts/release.sh
# Bump version
./scripts/version.sh patch # or minor, major
Development Workflow
graph LR
A[Fork Repo] --> B[Create Branch]
B --> C[Make Changes]
C --> D[Run Tests]
D --> E[Submit PR]
E --> F[Code Review]
F --> G[Merge]
G --> H[Release]
Contributing
- Fork the repository
- Create a feature branch (
feature/my-feature) - Make your changes with tests
- Submit a pull request
See CONTRIBUTING.md for detailed guidelines.
Related
See also
- [[Docker]]
- [[Jekyll]]
- [[Customization]]
- [[Installation]]