Skip to content

Commit 740f4e2

Browse files
authored
docs: address stability concerns and open contribution path
Added production readiness section and contributing guidelines to README.
1 parent c2273be commit 740f4e2

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,8 @@ $ zl doctor
164164

165165
## Plugins
166166

167+
> **Quality over quantity.** ZeroLinux ships 4 plugins that work perfectly and are security-scanned — instead of 300 that silently break your shell. Each plugin follows a strict contract and can be extended by the community. [Write your own →](#write-a-plugin)
168+
167169
ZeroLinux ships four production-ready plugins. Enable what you need, ignore the rest.
168170

169171
### git
@@ -344,14 +346,30 @@ Removes the block from `.zshrc`, deletes `~/.zerolinux`, removes the `zl` symlin
344346

345347
---
346348

349+
## ✅ Production Ready
350+
351+
ZeroLinux is not an experiment. It is tested, versioned, and CI-verified on every commit.
352+
353+
- **CI passes on every push** — ShellCheck static analysis on all shell files
354+
- **Automated plugin validation** — contract compliance checked automatically
355+
- **Semantic versioning** — every release follows semver strictly
356+
- **Safe by default** — installer never overwrites your config, always generates `restore.sh`
357+
- **Fully reversible** — one command uninstall, zero traces left behind
358+
359+
---
360+
347361
## Contributing
348362

363+
**Want to add a plugin?** The plugin system is designed for exactly this. Copy the `example` plugin, follow the contract, and open a PR — CI will validate everything automatically.
364+
349365
See [CONTRIBUTING.md](./CONTRIBUTING.md). The short version:
350366

351367
1. Fork → branch → change → test (`make test`) → PR
352368
2. All PRs run CI automatically
353369
3. New plugins must follow the contract in `plugins/example/`
354370

371+
**Plugin ideas welcome:** kubernetes, tmux, python/virtualenv, rust/cargo, ssh manager, and more.
372+
355373
---
356374

357375
## Acknowledgements
@@ -367,4 +385,3 @@ Built with zsh, fzf, and a lot of time spent staring at startup traces. Inspired
367385
[Report a bug](https://github.com/zerolinux-os/zero_terminal/issues/new?template=bug_report.yml) · [Request a feature](https://github.com/zerolinux-os/zero_terminal/issues/new?template=feature_request.yml) · [Sponsor](https://github.com/sponsors/zerolinux)
368386

369387
</div>
370-

0 commit comments

Comments
 (0)