Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (44 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 1.8 KB
Raw

Contributing to Resume-LD

Resume-LD is a local-first OSS utility for transparent semantic resume metadata. Contributions should keep the project small, inspectable, deterministic, and easy to run locally.

Local Setup

npm install
npm run dev
npm test

The app stores local files under data/:

  • data/uploads
  • data/exports
  • data/resume-ld.sqlite

Architecture Philosophy

  • Keep systems small and composable.
  • Prefer explicit validation over permissive parsing.
  • Preserve original PDFs and write only copied exports.
  • Avoid abstractions that do not remove real complexity.
  • Avoid cloud dependencies, user accounts, analytics, and multi-tenant assumptions.

Semantic Rules

Resume-LD metadata is descriptive. It may describe professional context, work visibility, evidence links, and evaluation context. It must not instruct hiring systems how to rank, select, pass, or reject a candidate.

Schema contributions should:

  • Use schema.org terms first when appropriate.
  • Add Resume-LD vocabulary only when schema.org does not express the need clearly.
  • Include examples and tests.
  • Preserve strict rejection of unknown fields unless the schema is intentionally extended.

Validation Expectations

Every schema or safety change should include tests for:

  • Required fields.
  • Unsupported fields.
  • Enum validation.
  • Max lengths.
  • Safety violations.
  • Semantic summary behavior when relevant.

Safety Requirements

Do not add features that support:

  • ATS bypassing.
  • Keyword stuffing.
  • Hidden prompt injection.
  • Hiring decision instructions.
  • Ranking or score manipulation.
  • Resume rewriting or AI-generated claims.

Contribution License

By contributing to Resume-LD, you agree that your contributions are licensed under the Apache License, Version 2.0.

Copyright 2026-2030 Gregory Kulp