Set up docs/CI in repo

Aperta
#7 3 commenti 0 reazioni 1 assegnatario Vedi su GitHub

@axl1313 ci sta già lavorando.

Dal 18/12/2025.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

See Anish's recommendations (from #tlm Slack channel):

  • Project manager and build backend: Hatch and Hatchling
    • I see you're already using this
  • Installer: uv (via installer = "uv" option in pyproject.toml)
    • Lot faster than the default pip installer
    • For a Python library using Hatchling as the build system, I don't think you need the .python-version or uv.lock
  • Code quality and CI: GitHub Actions, Mypy, Ruff (via hatch fmt), Pytest (via hatch test), Codecov
  • Docs: mkdocs-material and mkdocstrings-python, built in GitHub Actions and hosted using GitHub pages (via artifact, not branch)
    • Popular libraries like Pydantic AI and DSPy use mkdocs-material, you could take inspiration from their configuration. I also used this documentation system for a personal project a couple months ago, feel free to copy configurations from there.
Lingua principale
Python
Stelle
9
Fork
6
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di cleanlab/tlm

Tutte le issue di cleanlab/tlm

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.