QuantEcon / QuantEcon/QuantEcon.py
DOC: Freshness pass on contributor- and identity-facing files
Open
Nobody has claimed this yet.
documentation
good first issue
low-priority
- Dominant language
- Python
- Stars
- 2.4k
- Forks
- 2.3k
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 3
Description
Problem
Repo-meta files have drifted from reality:
.github/copilot-instructions.mdstates "536 tests" and a fixed runtime; the suite is 600 tests and runtime varies by mode (~2 to ~6 minutes depending on coverage instrumentation and machine). Agents onboarding from this file inherit stale facts; prefer phrasing that ages well ("600+ tests, several minutes; never cancel").README.mdleads install guidance with "we recommend you install the Anaconda Python distribution" — 2015-vintage advice, awkward under Anaconda's current licensing for many organisations. Lead withpip install quantecon; keep conda-forge as the conda path without Anaconda-the-distribution as a prerequisite.CITATION.cffis frozen atdate-published: 2024-01-06with noversion:field — citation tooling emits a years-old snapshot for a package ten releases newer. Addversion:and a release-checklist line to bump both per release (or wire the release workflow to do it).
Acceptance criteria
-
cffconvert --validatepasses; CITATION carries current version and date, and the release checklist owns keeping it true - README install section is pip-first
- copilot-instructions facts match the suite or are phrased durably
From the July 2026 technical-debt audit (AI-assisted; claims verified against 28d4b3b on 2026-07-25).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing .github/copilot-instructions.md, README.md, and CITATION.cff, then run cffconvert --validate and inspect the repository's release checklist or workflow. Done means the installation guidance is pip-first, onboarding facts are durable, and CITATION.cff has the current version and date with release ownership documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100