docs: add example output excerpt for repo-rule-detector

2026-07-19 09:41:42 +00:00 · 2026-03-08 09:17:51 +10:00
parent 234fbd73fd
commit 5376f2d2cc
1 changed files with 17 additions and 0 deletions
@@ -16,6 +16,23 @@
 * Example:
 *   node scripts/repo-rule-detector.mjs microsoft/vscode
 *
+ * Example output (excerpt):
+ *   {
+ *     "rulesets": [
+ *       {
+ *         "rules": {
+ *           "required_linear_history": false,
+ *           "non_fast_forward": true,
+ *           "pull_request": {
+ *             "required_review_thread_resolution": false,
+ *             "allowed_merge_methods": ["merge","squash","rebase"],
+ *             "required_approving_review_count": 1
+ *           }
+ *         }
+ *       }
+ *     ]
+ *   }
+ *
 * Output notes:
 *   - rulesets[].rules.pull_request prints fields like:
 *     required_review_thread_resolution, allowed_merge_methods,