@@ -25,23 +25,21 @@ Enhancement suggestions are tracked as GitHub issues. When creating an enhanceme
2525
2626### 🔧 Adding New Guardrails
2727
28- Want to add a new validation script? Great! Here's how:
28+ Want to add a new validation rule? We have a comprehensive guide that covers the entire process!
2929
30+ 📚 ** [ See the Complete Guide for Adding New Validation Rules] ( ../docs/CONTRIBUTING-NEW-RULES.md ) **
31+
32+ This guide covers:
33+ - Creating shared validators and standalone scripts
34+ - Setting up test infrastructure
35+ - ESLint plugin integration
36+ - GitHub Actions configuration
37+ - Documentation requirements
38+ - Example templates and best practices
39+
40+ For a quick overview:
30411 . ** Create the validation script** in ` scripts/validation/ `
31- 2 . ** Follow the existing pattern** :
32- ``` javascript
33- // check-your-rule.js
34- const RULE_NAME = ' your-rule' ;
35- const DEFAULT_OPTIONS = {
36- // Your default configuration
37- };
38-
39- function validate (files , options = {}) {
40- // Your validation logic
41- }
42-
43- module .exports = { validate, RULE_NAME };
44- ```
42+ 2 . ** Follow the existing pattern** from other validation scripts
45433 . ** Add tests** for your guardrail
46444 . ** Update the documentation** in README.md
47455 . ** Add examples** in docs/EXAMPLES.md
0 commit comments