@@ -15,6 +15,7 @@ This document provides instructions for AI assistants working with code that use
1515| Process large files | Use ` ValidationRunner ` with iterator input |
1616| Export failures | Use ` CSVFailedWriter ` or ` JSONLinesFailedWriter ` |
1717| Track progress | Add observer implementing ` ValidationObserver ` protocol |
18+ | Report package issues | Use GitHub MCP to create issue on ` Abstract-Data/abstract-validation-base ` |
1819
1920---
2021
@@ -516,3 +517,82 @@ result.add_error("field", "message") # Sets is_valid=False automatically
516517| ` ROW_PROCESSED ` | ValidationRunner | ` row_index ` , ` is_valid ` , ` stats_snapshot ` , ` errors ` |
517518| ` BATCH_STARTED ` | ValidationRunner | ` batch_number ` , ` batch_size ` |
518519| ` BATCH_COMPLETED ` | ValidationRunner | ` batch_number ` , ` batch_size ` |
520+
521+ ---
522+
523+ ## Reporting Issues to This Package
524+
525+ If you're an AI agent assisting with a project that uses ` abstract-validation-base ` and you discover a bug, missing feature, or documentation issue, you can file an issue against this package.
526+
527+ ** Repository:** ` Abstract-Data/abstract-validation-base `
528+
529+ ### Using MCP GitHub Server (Recommended for AI Agents)
530+
531+ If your AI client (Cursor, Claude Desktop, etc.) has the GitHub MCP server configured, use the ` create_issue ` tool targeting ` Abstract-Data/abstract-validation-base ` .
532+
533+ ** Cursor** (` ~/.cursor/mcp.json ` ):
534+ ``` json
535+ {
536+ "mcpServers" : {
537+ "github" : {
538+ "command" : " npx" ,
539+ "args" : [" -y" , " @modelcontextprotocol/server-github" ],
540+ "env" : {
541+ "GITHUB_PERSONAL_ACCESS_TOKEN" : " <your-token>"
542+ }
543+ }
544+ }
545+ }
546+ ```
547+
548+ ### Issue Guidelines
549+
550+ When filing issues, please include:
551+
552+ 1 . ** Clear title** prefixed with ` [Bug] ` , ` [Feature] ` , or ` [Docs] `
553+ 2 . ** Package version** (` abstract_validation_base.__version__ ` )
554+ 3 . ** Minimal reproduction** - smallest code that demonstrates the issue
555+ 4 . ** Expected vs actual behavior**
556+ 5 . ** Environment** - Python version, OS
557+
558+ ### Issue Templates
559+
560+ ** Bug Report:**
561+ ```
562+ ## Description
563+ [What went wrong]
564+
565+ ## Steps to Reproduce
566+ 1. [First step]
567+ 2. [Second step]
568+
569+ ## Expected Behavior
570+ [What should happen]
571+
572+ ## Actual Behavior
573+ [What actually happens]
574+
575+ ## Environment
576+ - Package Version: X.Y.Z
577+ - Python Version: 3.X
578+ - OS: [macOS/Linux/Windows]
579+
580+ ## Additional Context
581+ [Stack traces, related issues, etc.]
582+ ```
583+
584+ ** Feature Request:**
585+ ```
586+ ## Problem Statement
587+ [What limitation or pain point does this address?]
588+
589+ ## Proposed Solution
590+ [What would you like to see?]
591+
592+ ## Alternatives Considered
593+ [Other approaches you've thought about]
594+
595+ ## Use Case
596+ [Example code showing how this would be used]
597+ ```
598+
0 commit comments