gorakhargosh/watchdog

docs: add more real-world example scripts

開放

#1,190 建立於 2026年8月4日

 (2 則留言) (0 個反應) (0 位負責人)Python (772 個分叉)batch import
Good first issueHelp welcome :)documentation

倉庫指標

星標
 (7,396 顆星)
PR 合併指標
 (平均合併 25分鐘) (30 天內合併 1 個 PR)

描述

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!

貢獻者指南