Skip to main content

Writing Contracts

Coming Soon

Comprehensive guide for writing behavioral contracts is under construction.

Quick Start​

See Contributing > Writing Contracts for a basic template.

Schema Reference​

For complete field documentation, see Schema Reference.

Best Practices​

More detailed best practices coming soon. Key points:

  1. Source Everything - Every claim needs a documentation URL
  2. Be Specific - Clear, actionable required_handling text
  3. Use Proper Severity - Error for crashes, Warning for edge cases, Info for tips
  4. Test Fixtures - Create test cases in fixtures/ directory
  5. Verify Manually - Check against package docs before submitting

Need Help?​