Doc coverage
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Attiva
- Stack tecnologico
- github-actions, python
- Ambito
- ci-cd, documentation, testing-qa
Direzione di ricerca
Start with docs/source/tutorials/ and the existing command pytest --nbval docs/source/tutorials/ --cov=causal_testing --cov-report=html. Investigate how tutorial execution, coverage reporting, and GitHub Actions are currently configured. Done should be a documented workflow that reports tutorial code coverage and exposes the result through a badge, with exclusions supported.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Given a tutorial folder, what percentage of the code base is (recursively) imported AND USED at any point into the tutorials? Github action and badge.
This can be done (naively) as follows:
- Take the tutorials and run them
- Measure code coverage
- What percentage of codebase was covered? (ignore exceptions, have a #pragma no cover type comment)
Does this exist?! This is much more generally applicable than just for CTF, but I really want it to stop me merging undocumented PRs.
This is just codecov isn't it.
pytest --nbval docs/source/tutorials/ --cov=causal_testing --cov-report=html
- Lingua principale
- Python
- Stelle
- 20
- Fork
- 7
- Merge medio
- 8g 21h
- PR unite (30g)
- 2
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di CITCOM-project/CausalTestingFramework
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 50/100
-
Pydantic for serialisationForse già presa @SylviaWhittle l’ha presa 6 giorni fa. Aperta
CITCOM-project/CausalTestingFramework#419 · 1 assegnatario ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 64/100
Tutte le issue di CITCOM-project/CausalTestingFramework
Issue simili
-
bug good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
yunaremaia/proto-drift#22 ·
-
bug good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
yunaremaia/memwatch#96 ·
-
bug good first issue
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 91/100
yunaremaia/ci-gate-watch#34 ·
-
bug good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
yunaremaia/agent-capability-attestation#64 ·
I maintainer di solito rispondono entro 1 giorno
-
bug good first issue
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 86/100
yunaremaia/agent-call-graph#43 ·
I maintainer di solito rispondono entro 1 giorno