mirror of
https://github.com/srbhr/Resume-Matcher.git
synced 2026-01-14 11:44:14 +00:00
1ccdebb6c4
- Introduced JD Match feature documentation detailing how tailored resumes match job descriptions. - Added Resume Template Settings documentation outlining template types and formatting controls. - Created LLM Integration Guide for multi-provider AI support, JSON handling, and prompt guidelines. - Compiled Agent Documentation Index for modular documentation on AI agents working with Resume Matcher. - Developed Maintainer Guide for the resume editor, covering architecture, types, and PDF handling. - Established a Code Review & Technical Debt TODO document to track critical issues and improvements.
1.8 KiB
1.8 KiB
Workflow: Commits, PRs, and Testing
Git workflow, testing guidelines, and PR conventions.
Commit Guidelines
- Use concise, sentence-style subjects (e.g.,
Add custom funding link to FUNDING.yml) - Keep messages short
- If using prefixes, stick to
type: summaryin the imperative - Reference issues with
Fixes #123
Examples
Add resume enrichment wizard component
Fix PDF generation timeout on large resumes
Refactor LLM provider configuration
Pull Request Guidelines
- Reference issues:
Fixes #123in the description - Call out schema or prompt changes so reviewers can smoke-test downstream agents
- List local verification commands you ran
- Attach screenshots for UI or API changes
Testing Guidelines
Frontend Testing
- All contributions must pass
npm run lint - Add Jest or Playwright suites beneath
apps/frontend/__tests__/ - Name test files
*.test.tsx
# Run linter
npm run lint
# Format code
npm run format
Backend Testing
- Tests belong in
apps/backend/tests/ - Use
test_*.pynaming convention - Seed anonymized resume/job fixtures
# Run tests
cd apps/backend
uv run pytest
Definition of Done
Before marking a PR as ready:
- Code compiles without errors
npm run lintpasses- New features have tests (or documented reason why not)
- UI changes follow Swiss International Style
- Schema/prompt changes are called out in PR description
- Screenshots attached for UI changes
- Verified locally with commands listed in PR
Code Review Checklist
- Type hints on all Python functions
- Proper error handling (generic to clients, detailed in logs)
- No exposed secrets or API keys
- Follows existing patterns in the codebase
- Documentation updated if needed