Cursor rule

1---
2description: Require tests for new functionality and enforce documentation updates.
3globs: *.php, *.feature, README.md, *.md
4---
5# Tests & Documentation Maintenance
6 
7Ensures that tests are written and updated for Drupal modules and plugins, and that documentation remains current.
8 
9<rule>
10name: tests_documentation_maintenance
11description: Require tests for new functionality and enforce documentation updates.
12filters:
13  - type: file_extension
14    pattern: "\\.(php|feature|md|theme|module|install|info|inc)$"
15 
16actions:
17  - type: enforce
18    conditions:
19      - pattern: "class .*Test extends"
20        message: "Ensure all Drupal modules and plugins have unit tests."
21 
22      - pattern: "Feature:.*"
23        message: "Ensure front-end affecting plugins have Behat tests."
24 
25      - pattern: "function .*\\("
26        message: "When modifying existing functionality, check and update related tests."
27 
28      - pattern: "# README"
29        message: "Ensure README.md exists in each module and is kept up to date."
30 
31  - type: suggest
32    message: |
33      Keep tests and documentation updated:
34      - Write **unit tests** for Drupal modules and backend logic.
35      - Write **Behat tests** for plugins that affect front-end behavior.
36      - If functionality changes, **update corresponding tests**.
37      - Maintain a **README.md** file in each module and update it with relevant changes.
38 
39metadata:
40  priority: high
41  version: 1.0
42</rule>
43