Skip to content

🀝 Contributing

Public baseline on purpose. Bring prompts, gates, evals, and UX that make small models more reliable. Puns welcome. Secrets are not. πŸ”

πŸ’š

House style: conventional commits, human messages, no tool trailers, no ANSI art in git history. Your future bisect-self will buy you coffee.


Dev setup πŸ› οΈ

git clone https://github.com/UnicoLab/smlcode.git
cd smlcode
make tidy && make lint && make test
make install

Docs site πŸ“š

make docs-serve    # http://127.0.0.1:8000
make docs-build    # strict β†’ site/

Stack: MkDocs Material, custom CSS, GitHub Pages via Actions. If you change docs, make them fun and accurate. Both. We’re greedy like that.


Before a PR βœ…

  • make lint && make test
  • make docs-build
  • Conventional commits (feat:, fix:, docs:, …)
  • No secrets
  • Human commit messages (no tool trailers, no ANSI art)

Good first contributions 🌱

  • SLM eval fixtures
  • JSON repair edge cases
  • Studio/TUI polish (stay offline!)
  • Provider presets
  • Docs recipes that fail less often than reality πŸ˜…

β˜€οΈ Made with β™₯ by UnicoLab