12. Contributing

Contributions are welcome! Please follow these guidelines when submitting pull requests.

12.1 Quick Checklist

12.1.1 Code Changes

• All tests pass locally (./testing/run-tests.sh)
• New tests added for new functionality
• Code follows project style guidelines
• Self-review completed
• Code commented where necessary
• No new warnings generated

12.1.2 Documentation Changes

• Front matter added to new/updated pages (see PR template)
• Internal links tested (mkdocs serve)
• Code examples tested/verified
• New pages added to mkdocs.yml nav
• "See Also" sections updated with cross-references
• No hardcoded version numbers or test counts
• Images optimized (<500KB) with alt text

12.2 Testing

Run the test suite before submitting:

cd testing
./testing/run-tests.sh

See Running Tests for details.

12.3 Pull Request Template

The full PR checklist is available in .github/PULL_REQUEST_TEMPLATE.md.