[DOC] Update documentation for running tests with local services

Aperta Adatta ai principianti
#1,708 6 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
74/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
docker, docker-compose, python
Ambito
documentation

Direzione di ricerca

Inizia dalla sezione della documentazione relativa alla configurazione dei servizi locali e dalla guida ai test. Confronta le istruzioni esistenti con le modifiche ai servizi locali nelle PRs #1629 e #1697, quindi documenta i passaggi necessari per le autorizzazioni e l'esecuzione di pytest con OPENML_USE_LOCAL_SERVICES; il lavoro sarà considerato completato quando i contributori potranno seguire entrambi i workflow senza usare il server di test remoto.

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

Descrizione

Documentation Good First Issue

We recently switched the CI to run tests against local services using Docker instead of the remote test server. This change was introduced in:

The documentation should now be updated to explain how contributors can run the test suite using these local services.

Proposed changes:

  1. Update local service setup

    In the documentation for starting the local services, add the additional permission setup steps required before running docker compose, as implemented in #1697.

  2. Update the testing guide

    Extend the test guide with instructions on how to run pytest against the local services.
    This requires setting the environment variable: OPENML_USE_LOCAL_SERVICES

Lingua principale
Python
Stelle
361
Fork
296
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

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 openml/openml-python

Tutte le issue di openml/openml-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.