Developer
070cd4d5a5
Add generated .pi-map.md and .pi-map.index.md files across the repository so the project navigation maps are shared and versioned. These artifacts are maintained by project_map_init/patch/validate and must be kept in sync with source edits. Note: .cache/ remains ignored (added in previous commit).
1.6 KiB
1.6 KiB
docs/development
dir: docs/development
index: docs/development/.pi-map.index.md
role
Developer onboarding and contribution standards documentation for the Headquarter full-stack web application project.
files
- contributing.md | Provides guidelines and workflows for contributing to the Headquarter project | dep: git, ruff, mypy, pytest, npm, React, TypeScript, Python
- quality-gates.md | Defines mandatory quality gates (linting, type checking, testing, security, build) for backend (Python) and frontend (TypeScript) code before merge, including CI/CD integration and IDE setup. | dep: ruff, mypy, pytest, bandit, safety, TypeScript, ESLint, Vitest, pre-commit, npm, make
- setup.md | Provides step-by-step instructions for setting up a full-stack development environment for a FastAPI/React application with PostgreSQL, Redis, and optional Authentik authentication. | dep: Python 3.11+, Node.js 18+, PostgreSQL 15+, Redis 7+, Git, Docker, FastAPI, React, Alembic, uvicorn, npm, Authentik
- testing.md | Documents testing practices, frameworks, and guidelines for both backend (Python/pytest) and frontend (React/Vitest) of a web application called "Headquarter" | dep: pytest, pytest-asyncio, httpx, factory-boy, vitest, react-testing-library, jsdom, playwright, asyncpg, postgresql, authentik, github-actions
arch
Documentation-as-code approach with structured markdown files covering environment setup, quality assurance gates, testing standards, and contribution workflows for a FastAPI/React/PostgreSQL/Redis stack.
tags
pytest, react, testing, contributing, npm, typescript, python, quality