37 lines
2.4 KiB
Markdown
37 lines
2.4 KiB
Markdown
# Project Guidelines
|
|
|
|
## Code Style
|
|
- Primary source is `resume.tex`; keep edits focused there unless build config changes are required.
|
|
- Follow existing LaTeX macro style: reusable `\newcommand` helpers for resume blocks (e.g., `\resumeSubheading`, `\resumeEducation`, `\resumeItem`).
|
|
- Preserve compact spacing/layout conventions (`\vspace`, custom `\titleformat`, `tabular*` alignment) unless asked to redesign formatting.
|
|
- Keep package usage consistent with current preamble and avoid adding new packages unless required for a user request.
|
|
|
|
## Architecture
|
|
- This workspace is a single-document resume project.
|
|
- `resume.tex` contains both template macros and resume content.
|
|
- Files like `resume.aux`, `resume.fdb_latexmk`, and `resume.fls` are generated build artifacts, not source-of-truth.
|
|
- `glyphtounicode` is included for text extractability/ATS friendliness via `\pdfgentounicode=1`.
|
|
|
|
## Build and Test
|
|
- Preferred reproducible build: `nix build .#default` (outputs `result/resume.pdf`)
|
|
- Local TeX build: `latexmk -pdf resume.tex`
|
|
- Alternative build: `pdflatex resume.tex` (run multiple times if references/layout need settling)
|
|
- Clean artifacts: `latexmk -c`
|
|
- Validate by checking successful compile and reviewing resulting `resume.pdf` for layout overflow/line wrapping regressions.
|
|
|
|
## Project Conventions
|
|
- Use existing macros instead of ad-hoc formatting in section bodies.
|
|
- Keep section/list structure aligned with current pattern: `\resumeSubHeadingListStart` / `\resumeSubHeadingListEnd` and `\resumeItemListStart` / `\resumeItemListEnd`.
|
|
- Keep content concise and achievement-oriented; avoid large prose blocks that break one-page layout assumptions.
|
|
- Do not manually edit generated files (`*.aux`, `*.fdb_latexmk`, `*.fls`, etc.); `.gitignore` already treats these as build outputs.
|
|
- Prefer linking to existing guidance instead of duplicating it: see `.github/prompts/resume-review.prompt.md` for the structured review workflow.
|
|
|
|
## Integration Points
|
|
- External links are rendered with `hyperref` (`hidelinks`) and should stay valid/HTTPS.
|
|
- Typography/layout relies on current package set (`sourcesanspro`, `titlesec`, `multicol`, `tabularx`); changing these can significantly alter spacing.
|
|
|
|
## Security
|
|
- Resume data includes personally identifiable information (name, location, email, phone, profile URLs).
|
|
- Do not invent or expose new sensitive personal details when generating edits.
|
|
- Prefer placeholders when asked to add unknown contact/private information.
|