gorakhargosh/watchdog

docs: add more real-world example scripts

Ouverte

#1 190 ouverte le 4 août 2026

Voir sur GitHub
 (2 commentaires) (0 réaction) (0 personne assignée)Python (772 forks)batch import
Good first issueHelp welcome :)documentation

Métriques du dépôt

Stars
 (7 396 étoiles)
Métriques de merge PR
 (Merge moyen 25m) (1 PR mergée en 30 j)

Description

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!

Guide contributeur

Direction de recherche
Examinez les exemples existants dans docs/source/examples/, l'utilisation de literalinclude dans docs/source/examples.rst et la liste des tests dans tests/test examples.py pour comprendre le modèle de contribution.
Stack technique
python
Domaine
documentationtesting
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85