gorakhargosh/watchdog

docs: add more real-world example scripts

Aperta

#1190 aperta il 4 ago 2026

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Python (772 fork)batch import
Good first issueHelp welcome :)documentation

Metriche repository

Star
 (7396 stelle)
Metriche merge PR
 (Merge medio 25m) (1 PR mergiata in 30 g)

Descrizione

Description

Following our efforts to improve the documentation and the introduction of the new Examples page, we want to expand our gallery of practical, real-world watchdog configurations.

We would like to invite first-time contributors to add clean, executable example Python scripts for common use cases.

How to contribute:

  1. Choose/Propose a Use Case:
  2. Add a Python script: Create a new Python script under docs/source/examples/ (e.g. docs/source/examples/renaming.py). Make sure it is self-contained and clean.
  3. Link to the docs: Open docs/source/examples.rst and include your script using the literalinclude directive: 
    .. literalinclude:: examples/renaming.py
   :language: python
   :linenos:
  4. Register in tests: Open tests/test_examples.py and add your example script name to the list of tested files so that it gets automatically tested in CI/CD.
  5. Open a PR!

Guida contributor

Direzione di ricerca
Esamina gli esempi esistenti in docs/source/examples/, l'uso di literalinclude in docs/source/examples.rst e la lista dei test in tests/test examples.py per comprendere il modello di contribuzione.
Tech stack
python
Dominio
documentationtesting
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85