QuantEcon / QuantEcon/QuantEcon.py

DOC: Add SECURITY.md and enable private vulnerability reporting

Open Beginner friendly
#891 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Problem

The repository has no SECURITY.md and no documented private channel for reporting a vulnerability. For a package with thousands of forks, a JOSS publication, and wide use in teaching environments, a finder's only options today are a public issue (which discloses the problem before a fix exists) or an untracked email (no SLA, no audit trail).

GitHub Private Vulnerability Reporting is a one-click enablement in repository settings and gives reporters a private, tracked channel with a coordinated-disclosure workflow.

Acceptance criteria
  • SECURITY.md at the repository root: supported versions, how to report, expected response time
  • GitHub Private Vulnerability Reporting enabled
  • SECURITY.md points at the private reporting channel rather than an email address
  • Consistent with any QuantEcon org-level security policy; if one exists, reference it rather than restating it

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

Start by checking the repository root for an existing SECURITY.md and reviewing any QuantEcon organization-level security policy. Verify the GitHub private vulnerability reporting setting in repository settings, then document supported versions, reporting steps, and response time while referencing the organization policy where appropriate. Done means the file is present and points to the enabled private channel.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation, security
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.