QuantEcon / QuantEcon/QuantEcon.py
Review developer/contributing documentation for completeness
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.4k
- Forks
- 2.3k
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 3
Description
Context
The quantecon.org website is removing its developer instruction pages (see QuantEcon/website#201), since developer docs were migrated to this repo in #740. The website's Contribute buttons now point at the rendered contributing guide:
https://quanteconpy.readthedocs.io/en/latest/contributing.html
This is a request to review that the developer docs here fully cover what the website pages used to provide.
Removed website pages and their coverage
| Removed page | Topics | Covered by docs/source/contributing.rst? |
|---|---|---|
/python-developers/ |
Conda dev env, tests, documentation, package structure, the QuantEcon.py API | Partially — the Package structure and API sections have no equivalent |
/wiki-py-conda-dev-env/ |
Step-by-step Conda development environment setup | Summarised only |
/wiki-py-docstrings/ |
Detailed numpydoc docstring guide (~280 lines) | Unclear — worth checking nothing of value was lost |
/wiki-py-unit-testing/ |
Unit testing guide — test naming, assertion methods, examples (~130 lines) | Unclear — worth checking nothing of value was lost |
The full text of the removed pages is retrievable from the website repo history if anything needs porting.
Suggestion: add a root CONTRIBUTING.md
The repo currently has no root CONTRIBUTING.md (or .github/CONTRIBUTING.md), so GitHub shows no contributing-guidelines link on new issues/PRs. A short stub that links to the rendered readthedocs guide would be enough.
🤖 Generated with Claude Code
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 with docs/source/contributing.rst and compare it with the removed website pages in the website repository history, focusing on package structure, the API, Conda setup, docstrings, and unit testing. Check whether a root CONTRIBUTING.md or .github/CONTRIBUTING.md exists; done means documenting any missing material and adding the suggested link stub if appropriate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100