Skip to content

DOC: Refresh contributor-facing metadata #907

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
deepakganesh78 wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −14
Open

DOC: Refresh contributor-facing metadata #907

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions .github/copilot-instructions.md
View file
Open in desktop

@quantecon-services quantecon-services Sep 9, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file no longer exists on main — #941 deleted it and replaced it with AGENTS.md, which already uses durable wording ("The full suite takes minutes") and carries no test count. That makes this part of the PR obsolete and it is one of the two merge conflicts GitHub is reporting (modify/delete).

Please drop this file from the PR when you rebase; nothing from it needs to be carried over to AGENTS.md.

Generated by Claude Code

Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,8 @@ Always reference these instructions first and fallback to search or bash command
- Takes < 30 seconds
- Note: Repository has some existing style violations - this is expected
- **Full test suite**: `coverage run -m pytest quantecon`
- Takes 5 minutes 11 seconds. NEVER CANCEL. Set timeout to 15+ minutes.
- Runs 536 tests across all modules
- All tests should pass with 2 warnings (expected)
- Runs 600+ tests and takes several minutes. NEVER CANCEL. Set timeout to 15+ minutes.
- All tests should pass; investigate any unexpected warnings.
- **Quick smoke test**: `python -c "import quantecon as qe; print('Version:', qe.__version__)"`
- **Package build**: `flit build`
- Creates wheel and source distributions in dist/
Expand Down Expand Up @@ -54,7 +53,7 @@ print('DiscreteDP test successful, policy:', result.sigma)
- `game_theory/` - Game theory algorithms and utilities
- `optimize/` - Optimization algorithms
- `random/` - Random number generation utilities
- `tests/` - Main test suite (536 tests total)
- `tests/` - Main test suite (600+ tests total)

### Configuration Files
- `pyproject.toml` - Main project configuration using flit build system
Expand All @@ -74,7 +73,7 @@ Core runtime dependencies (auto-installed in conda env):

**CRITICAL TIMING INFORMATION:**
- **Conda environment creation**: 3-5 minutes (timeout: 10+ minutes)
- **Full test suite**: 5 minutes 11 seconds (timeout: 15+ minutes)
- **Full test suite**: several minutes (timeout: 15+ minutes)
- **Package build**: < 30 seconds (timeout: 2 minutes)
- **Development install**: < 30 seconds (timeout: 2 minutes)
- **Linting**: < 30 seconds (timeout: 2 minutes)
Expand Down
2 changes: 2 additions & 0 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
cff-version: "1.2.0"
version: "0.11.4"
date-released: 2026-07-15
Comment on lines +2 to +3

@quantecon-services quantecon-services Sep 9, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified: this validates with cffconvert --validate (schema 1.2.0), 0.11.4 matches quantecon.__version__ on main, and 2026-07-15 matches the v0.11.4 GitHub release date. The rendered citation now reads "(2026) … (version 0.11.4)" instead of the frozen 2024 snapshot — nice.

One suggestion so this stays true: #900 floated "or wire the release workflow to do it". A few-line step in the tag-triggered publish job in ci.yml that fails if version: here doesn't equal quantecon.__version__ (or the v* tag) would make the checklist self-enforcing rather than relying on memory. Happy for that to be a follow-up if you'd rather keep this PR docs-only.

Generated by Claude Code

authors:
- family-names: Batista
given-names: Quentin
Expand Down
6 changes: 2 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,11 @@ A high performance, open source Python code library for economics

## Installation

Before installing `quantecon` we recommend you install the [Anaconda](https://www.anaconda.com/download/) Python distribution, which includes a full suite of scientific python tools.

Next you can install quantecon by opening a terminal prompt and typing
Install `quantecon` from PyPI by opening a terminal and typing

pip install quantecon

or using conda-forge by typing
Alternatively, install the conda-forge package by typing

conda install -c conda-forge quantecon

Expand Down
9 changes: 9 additions & 0 deletions docs/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,15 @@ The rendered pages are written to ``docs/build/html``. Once you open a pull requ
documentation is also built automatically by `Read the Docs <https://readthedocs.org>`_ and linked from
the pull request checks.

Prepare a release
-----------------

Before tagging a release:
Comment on lines +83 to +86

@quantecon-services quantecon-services Sep 9, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the second merge conflict: #941 added a "Multi-phase projects and releases" section at exactly this spot on main. Both should be kept.

Suggest folding this checklist into (or placing it directly after) that section, and reconciling the wording with its existing line "treat the milestone as the release checklist" — e.g. "Before tagging, also: ..." so the two don't read as competing release procedures.

Generated by Claude Code


* Update ``__version__`` in ``quantecon/__init__.py``.
* Update ``version`` and ``date-released`` in ``CITATION.cff`` to match the release.
* Run ``cffconvert --validate`` to validate the citation metadata.

@quantecon-services quantecon-services Sep 9, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cffconvert isn't in environment.yml or any requirements file, so this step asks the release manager to run a tool they won't have. Either add it to environment.yml, or say pip install cffconvert inline.

One caveat if you add it as a dependency: cffconvert 2.0.0 pins jsonschema<4, which fights with the modern stack (I hit this installing it locally to validate this PR). A lighter alternative is to run validation in CI via citation-file-format/cffconvert-github-action rather than making it a local dev dependency.

Generated by Claude Code


Further questions
-----------------

Expand Down
7 changes: 2 additions & 5 deletions docs/source/setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
Installation
============

Before installing `quantecon` we recommend you install the `Anaconda <https://www.anaconda.com/download/>`_ Python distribution,
which includes a full suite of scientific python tools.

Next you can install quantecon by opening a terminal prompt and typing
Install ``quantecon`` from PyPI by opening a terminal and typing

.. code:: bash

pip install quantecon

and using `conda-forge` by typing
Alternatively, install the ``conda-forge`` package by typing

.. code:: bash

Expand Down