QuantEcon / QuantEcon/QuantEcon.py

DOC: Add code of conduct, issue/PR templates, and CODEOWNERS

Open
#892 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation help wanted
Dominant language
Python
Stars
2.4k
Forks
2.3k
Avg merge
3d 3h
Merged PRs (30d)
3

Description

Problem

The repository is missing most standard community health files:

File Present
CHANGELOG.md
CITATION.cff
LICENSE
CONTRIBUTING.md ⚠️ 12-line pointer to the RTD guide
CODE_OF_CONDUCT.md
.github/ISSUE_TEMPLATE/
.github/PULL_REQUEST_TEMPLATE.md
.github/CODEOWNERS

The missing issue templates connect directly to the backlog-triage issue in this milestone: an unlabelled, decade-old backlog is what a repository with no triage scaffolding accumulates. A bug template that asks for versions of Python, NumPy, numba and SciPy would resolve a large share of triage questions before a maintainer reads the issue. CODEOWNERS is worth its own thought given that two contributors account for roughly 70% of recent human commits — routing reviews by subpackage at least makes the concentration visible.

Acceptance criteria
  • CODE_OF_CONDUCT.md, aligned with any QuantEcon org-level policy
  • Issue templates for bug report and feature request, capturing the version matrix
  • A pull request template referencing the contributing guide and the test/lint expectations
  • .github/CODEOWNERS routing reviews by subpackage
  • CONTRIBUTING.md covers the local dev loop (test, lint, docs build) inline rather than only linking out

From the July 2026 technical-debt audit (AI-assisted; claims verified against 28d4b3b on 2026-07-25).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing CONTRIBUTING.md and the repository's current community-health files, then compare the requested CODE_OF_CONDUCT.md, .github issue and pull-request templates, and .github/CODEOWNERS with the acceptance criteria. Confirm the Python, NumPy, numba, and SciPy version questions plus test, lint, and docs-build expectations. Done means all listed files exist, CODEOWNERS routes reviews by subpackage, and CONTRIBUTING.md documents the local development loop inline.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.