Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (33 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.11 KB
Raw

Contributing

GitHub Visualizer is a Vite, React, Three.js, and FastAPI project. Contributions that improve repository analysis, rendering performance, accessibility, docs, deployment, or backend reliability are welcome.

Development Setup

Backend:

cd backend
python3 -m venv .venv
. .venv/bin/activate
pip install -r requirements.txt
uvicorn app.main:app --reload --host 127.0.0.1 --port 8890

Frontend:

cd web
npm ci
npm run dev -- --host 0.0.0.0 --port 5173

Tests and Checks

cd backend
PYTHONPATH=. python3 -m unittest discover -s tests

cd ../web
npm run lint
npm run build

Pull Requests

  • Open an issue before large UI, scoring, storage, or API changes.
  • Keep backend GitHub token handling server-side only.
  • Include tests for scoring, normalization, or API changes.
  • Include screenshots or short recordings for visual changes.
  • Keep PRs scoped so review remains practical.

Maintainer Workflow

Good maintenance tasks include issue triage, GitHub API adapter improvements, accessibility fixes, CI hardening, deployment docs, and regression tests for scoring behavior.