ContextLab / ContextLab/chatify

Tests [TODO]

Aperta
#9 12 commenti 0 reazioni 0 assegnatari Vedi su GitHub
coding required non-coding
Lingua principale
Python
Stelle
23
Fork
11
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

# Overview

Write unit tests for each function

# Completion criteria

- [ ] For each function, add a "todo" issue to create a test for the function, describing (a) what the function is supposed to do and (b) how it should be tested. If there are any edge cases or tricky scenarios to watch out for, those should be noted too

# Resources (optional)

- [pytest](https://docs.pytest.org/en/7.3.x/): framework for writing and running tests
- [GitHub actions](https://github.com/features/actions): can be used to automate tests when pull requests are merged
- [davos](https://github.com/ContextLab/davos): archive contains useful code for running tests that involve notebooks

# Discussion points

Adding issues doesn't require coding, but it'd be good to have at least one "coding" person work on this task to help define useful tests.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Poiché non vengono indicati file o test, per prima cosa fai un inventario delle funzioni Python e del codice relativo ai notebook nel repository. Usa le risorse pytest e davos per definire una issue TODO per ogni funzione, documentandone il comportamento, l'approccio ai test e i casi limite; il completamento si ha quando ogni funzione ha una issue corrispondente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
github-actions, jupyter-notebook, python
Ambito
ci-cd, documentation, testing
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.