Files
jobtrackingapp/docs/technical/coding-standards.md
T
cesnimda b176a44627 docs: reorganize tree, restore architecture + research from archive, add Phase 0 reports
Active docs/ was stub scaffolding while the real docs sat in docs/_archive/.
Restore and correct them, and record the Phase 0 work.

- docs/architecture/current.md: verified system map (from archived SYSTEM_OVERVIEW,
  9 corrections against code).
- docs/research/competitors.md: sourced competitor analysis (from archived
  PRODUCT_RESEARCH, feature matrix corrected).
- docs/decisions/ADR-002-job-application-model.md: the Job/JobApplication split.
- docs/application-discovery-report.md, docs/implementation-roadmap.md,
  docs/phase-0-foundation-report.md, docs/career-workspace-branch-assessment.md.
- Remove 10 zero-byte placeholder files that advertised content that never existed.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-17 17:04:32 +02:00

526 B

Coding Standards

General Rules

Code should be:

  • Readable.
  • Self documenting.
  • Consistent.

Naming

Use meaningful names.

Avoid:

  • Short unclear variables.
  • Generic service names.

Methods

Prefer:

Small focused methods.

Avoid:

Large methods handling multiple responsibilities.


Error Handling

Errors should:

  • Be handled explicitly.
  • Provide useful messages.
  • Not expose sensitive information.

Comments

Comments should explain:

Why something exists.

Not what the code does.