Skip to content

docs: refresh contributor guide - #206

Open
Fhatu12 wants to merge 1 commit into
petertzy:mainfrom
Fhatu12:docs/update-contributor-guide
Open

docs: refresh contributor guide#206
Fhatu12 wants to merge 1 commit into
petertzy:mainfrom
Fhatu12:docs/update-contributor-guide

Conversation

@Fhatu12

@Fhatu12 Fhatu12 commented Jul 29, 2026

Copy link
Copy Markdown

Summary

  • Refreshes CONTRIBUTING.md to match the current FastAPI, Next.js, and Tauri project structure.
  • Adds contributor prerequisites, setup steps, local development workflow, and validation guidance by change type.
  • Adds docs-only contribution guidance, no-secret/API-key expectations, and issue/PR etiquette.
  • Notes that broad Research and Improve Product Competitiveness #187 contributions should stay small and focused.

Validation

  • git diff --check HEAD~1..HEAD
  • rg -n "pure Python and Tkinter|Guidlines|python app.py|Python >= 3.10|python-ci.yml|doc/" CONTRIBUTING.md || true

Scope note

This PR is intentionally focused on CONTRIBUTING.md only. It does not broaden into README wording polish, docs/index.md, or document outline / TOC functionality.

Refs #187

@Fhatu12
Fhatu12 requested review from lwu1822 and petertzy as code owners July 29, 2026 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant