ContextLab / ContextLab/chatify

Tests [TODO]

Offen
#9 12 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
coding required non-coding
Vorherrschende Sprache
Python
Sterne
23
Forks
11
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

# 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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Da keine Dateien oder Tests genannt werden, erstellen Sie zunächst ein Inventar der Python-Funktionen und des notebookbezogenen Codes im Repository. Verwenden Sie die pytest- und davos-Ressourcen, um für jede Funktion ein TODO-Issue zu definieren und dabei ihr Verhalten, den Testansatz und Sonderfälle zu dokumentieren; abgeschlossen ist die Aufgabe, wenn jede Funktion ein entsprechendes Issue hat.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
github-actions, jupyter-notebook, python
Bereich
ci-cd, documentation, testing
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.