CONTRIBUTING.md

Contributing to suRxit

Branch Naming

• Use feature/<short-description>, bugfix/<short-description>, or docs/<short-description>
• Example: feature/ocr-service
• Use docs/<short-description> for documentation

Commit Conventions

• Use Conventional Commits:
  • feat: add new NER pipeline
  • fix: correct entity linking bug
  • docs: update README
  • docs: update README

Code Review Rules

• All PRs require at least 1 reviewer approval
• Ensure tests and linting pass before merging
• Link issues in PR descriptions
• Use clear, descriptive PR titles
• Ensure CI passes before merging