Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
102 changes: 102 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
name: Bug report
description: Report behavior that does not match the documentation or the expected result
title: "[Bug]: "
body:
- type: markdown
attributes:
value: |
This form is shared by every repository in the organization, so it asks
for the repository rather than assuming one.

Remove API keys, account identifiers, positions, order identifiers, and
broker session data before submitting. A log line that proves the bug
does not need the account it happened on.

Do not report a security vulnerability here. See `SECURITY.md` in the
affected repository.

- type: input
id: repository
attributes:
label: Repository and version
description: Which repository, and the tag, release, or commit you ran.
placeholder: QuantPlatformKit v1.4.2, or commit 1a2b3c4
validations:
required: true

- type: textarea
id: summary
attributes:
label: What happened
description: One sentence on the observable behavior, then the detail.
placeholder: The rebalance planner emits an order for a symbol that the universe filter excluded.
validations:
required: true

- type: textarea
id: steps
attributes:
label: How to reproduce
description: The smallest sequence that still shows it. Include the command and the input it read.
placeholder: |
1. Run `python -m quant_platform_kit.plan --config configs/example.yaml`
2. Inspect the emitted order list
3. AAA is present, though the filter excludes it
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected result and actual result
placeholder: |
Expected: no order for AAA.
Actual: one order for AAA, size 100.
validations:
required: true

- type: dropdown
id: mode
attributes:
label: Execution mode
description: >
The most useful piece of context for a trading-system bug. State the
furthest the run got, even if it failed before reaching that step.
options:
- Offline data only, no broker connection
- Backtest or replay
- Paper or dry-run against a broker
- Live account with real orders
- Not applicable
validations:
required: true

- type: input
id: environment
attributes:
label: Environment
description: Python version, operating system, and broker or data provider if relevant.
placeholder: Python 3.13.2, macOS 15.3, IBKR paper gateway
validations:
required: true

- type: textarea
id: logs
attributes:
label: Logs or output
description: Sanitized. The lines around the failure, not the whole run.
render: text
validations:
required: false

- type: checkboxes
id: confirm
attributes:
label: Before submitting
options:
- label: I searched existing issues and this is not a duplicate.
required: true
- label: I removed credentials, account identifiers, positions, and order identifiers.
required: true
- label: This is not a security vulnerability.
required: true
72 changes: 0 additions & 72 deletions .github/engineering.md

This file was deleted.

11 changes: 6 additions & 5 deletions .github/governance/policy.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
{
"version": "pr-governance/v3",
"mode": "enforce",
"reviewer": {
"provider": "codex",
"app_id": 1144995,
"user_id": 199175422,
"login": "chatgpt-codex-connector[bot]"
"review_routing": {
"dispatch_mentions": [
"@codex review",
"@claude review"
]
},
"r0_paths": [
"README.md",
"README.zh-CN.md",
"CHANGELOG.md",
"docs/prose/"
],
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ jobs:
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6
with:
persist-credentials: false
- uses: actions/setup-python@v6
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6
with:
python-version: "3.12"
# The checker runs before the tests because a rule that stopped working
Expand Down
29 changes: 3 additions & 26 deletions .github/workflows/engineering-governance.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,33 +18,10 @@ jobs:
with:
fetch-depth: 0
persist-credentials: false
- name: Install verified Gitleaks CLI
shell: bash
run: |
set -euo pipefail
archive="$RUNNER_TEMP/gitleaks.tar.gz"
curl --fail --silent --show-error --location --retry 2 \
https://github.com/gitleaks/gitleaks/releases/download/v8.30.1/gitleaks_8.30.1_linux_x64.tar.gz \
--output "$archive"
echo "551f6fc83ea457d62a0d98237cbad105af8d557003051f41f3e7ca7b3f2470eb $archive" | sha256sum --check --status
mkdir -p "$RUNNER_TEMP/gitleaks-bin"
tar -xzf "$archive" -C "$RUNNER_TEMP/gitleaks-bin" gitleaks
- name: Scan added commits with redacted findings
shell: bash
env:
PR_BASE: ${{ github.event.pull_request.base.sha }}
PR_HEAD: ${{ github.event.pull_request.head.sha }}
PUSH_BASE: ${{ github.event.before }}
PUSH_HEAD: ${{ github.sha }}
run: |
set -euo pipefail
base="${PR_BASE:-$PUSH_BASE}"
head="${PR_HEAD:-$PUSH_HEAD}"
if [[ -z "$base" || "$base" =~ ^0+$ ]]; then
echo "No base commit is available for this event" >&2
exit 1
fi
"$RUNNER_TEMP/gitleaks-bin/gitleaks" git . --redact --no-banner --log-opts="$base..$head"
uses: Pigbibi/PrGovernance/pr-governance@ccda8de572d2893272b0137526ef3e2d45e5eee7
with:
mode: scan

commitlint:
name: Commit message convention
Expand Down
15 changes: 0 additions & 15 deletions .github/workflows/required-gitleaks.yml

This file was deleted.

17 changes: 11 additions & 6 deletions .github/workflows/risk-gate.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: PR risk gate

# Copy to .github/workflows/risk-gate.yml and replace QuantStrategyLab/.github with
# the organization's governance repository (for example Pigbibi/governance).
# Copy to .github/workflows/risk-gate.yml and replace Pigbibi/PrGovernance with
# the owner's governance repository (for example Pigbibi/PrGovernance).
# The job names in this file are the required status check contexts; keep them.

on:
Expand Down Expand Up @@ -51,11 +51,10 @@ jobs:
statuses: write
steps:
- name: Record label head
uses: QuantStrategyLab/.github/pr-governance@eec647dfa42e27f2caa0dc0e0ba289155488fe86
uses: Pigbibi/PrGovernance/pr-governance@ccda8de572d2893272b0137526ef3e2d45e5eee7
env:
GOVERNANCE_OWNER_ID: ${{ vars.RISK_GATE_OWNER_ID }}
GOVERNANCE_OWNER_LOGIN: ${{ vars.RISK_GATE_OWNER }}
GOVERNANCE_REVIEWERS_JSON: ${{ vars.GOVERNANCE_REVIEWERS_JSON }}
with:
mode: gate
record-label: 'true'
Expand All @@ -69,7 +68,8 @@ jobs:
(github.event_name != 'issue_comment' ||
(github.event.issue.pull_request &&
(github.event.comment.user.type == 'Bot' ||
contains(github.event.comment.body || '', 'codex-review'))))
contains(github.event.comment.body || '', 'codex-review') ||
contains(github.event.comment.body || '', 'ai-review-receipt'))))
runs-on: ubuntu-latest
timeout-minutes: 10
permissions:
Expand All @@ -85,10 +85,15 @@ jobs:
cancel-in-progress: true
steps:
- name: Evaluate
uses: QuantStrategyLab/.github/pr-governance@eec647dfa42e27f2caa0dc0e0ba289155488fe86
uses: Pigbibi/PrGovernance/pr-governance@ccda8de572d2893272b0137526ef3e2d45e5eee7
env:
GOVERNANCE_OWNER_ID: ${{ vars.RISK_GATE_OWNER_ID }}
GOVERNANCE_OWNER_LOGIN: ${{ vars.RISK_GATE_OWNER }}
# Optional: a repository that keeps account identifiers out of public
# source configures the reviewer here instead of in policy.json.
GOVERNANCE_REVIEWER_APP_ID: ${{ vars.RISK_GATE_REVIEWER_APP_ID }}
GOVERNANCE_REVIEWER_USER_ID: ${{ vars.RISK_GATE_REVIEWER_USER_ID }}
GOVERNANCE_REVIEWER_LOGIN: ${{ vars.RISK_GATE_REVIEWER_LOGIN }}
GOVERNANCE_REVIEWERS_JSON: ${{ vars.GOVERNANCE_REVIEWERS_JSON }}
with:
mode: gate
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/weekly-gitleaks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ permissions:
jobs:
secret-scan:
name: Secret scan
uses: QuantStrategyLab/.github/.github/workflows/gitleaks.yml@0da4da68433b803cda17d3f84e29875a94a32273
uses: QuantStrategyLab/.github/.github/workflows/gitleaks.yml@925d718e440bd5cc7c4537ffef2fd53a2f0e654d
with:
full-history: true
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ gha-creds-*.json
# personal global ignore excludes Markdown.
!AGENTS.md
!CLAUDE.md
!.github/engineering.md

# Local editor, OS and tool cache files.
.DS_Store
Expand All @@ -41,3 +40,9 @@ docs/audits/
docs/plans/
docs/handoffs/
docs/superpowers/

# Working notes are drafts, not documentation.
docs/changes/
docs/acceptance-policy.md
.claude/
.codex/
Loading
Loading