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:
- Choose/Propose a Use Case:
- 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. - Link to the docs: Open
docs/source/examples.rstand include your script using theliteralincludedirective:.. literalinclude:: examples/renaming.py :language: python :linenos: - 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.
- Open a PR!