Skip to content

Adopt solprop's standard for issues and pull requests - #9

Merged
jtravs merged 2 commits into
mainfrom
chore/issue-standard
Nov 4, 2026
Merged

jtravs merged 2 commits into
mainfrom
chore/issue-standard

Conversation

@jtravs

@jtravs jtravs commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

First of three PRs bringing optmat up to solprop's project standards, now that solprop is public. This one covers issues and contributor guidance. The next two cover changelog fragments, then moving the roadmap to issues.

What changed

  • CONTRIBUTING.md: adds Check what already exists, the report form, Writing an issue and Labels. The search now covers solprop's issues and SEPs too. Additions for a data library: cite TC-n and the source record, nothing from memory, no pasted paper text or PDFs.
  • .github/ISSUE_TEMPLATE/: report a value, offer a source, planned work, OEP tracking, and a config linking the standard and solprop's issues.
  • AGENTS.md:
    • Project facts gain Planned work and Downstream.
    • A new Working agreement section.
    • The agent rule "never push" becomes "merge, push, tag or release only when asked or authorised".
    • The proposal-only exception widens to all documentation-only changes. Code keeps the full local gate.
  • OEP 0 and the template: planned work goes in issues, each OEP gets a tracking issue, and a draft lists the open issues it touches. The change is recorded in OEP 0's history as a maintainers' decision, without a Process OEP (§2, §10).
  • Frozen fixtures: the solprop_*.json fixtures are now described as frozen. solprop takes these values from optmat, so re-running tools/solprop_*.py would compare optmat with itself.
  • docs/contributing.md: matched to the above. This also removes a stale line saying agents confirm branch creation first, which contradicted AGENTS.md.

Already applied to the repository, not in this diff: the labels the guide describes, and priority: low + area: solids on #6.

Interim state: OEP 0 now says planned work goes in issues, but docs/roadmap.md still holds its informal items until the third PR moves them.

Verified (documentation-only checks): git diff --check, codespell on the changed files, poe reuse, tests/test_proposals.py and tests/test_register.py (75 passed, 1 skipped), and poe docs. The YAML templates parse, but they render only once on main, so I'll check issues/new/choose after merge. The private-wording scan reports no new hits against the baseline.

Not run: the full gate, since this is documentation only; CI runs it here.

🤖 Generated with Claude Code

jtravs and others added 2 commits November 4, 2026 10:52
CONTRIBUTING gains what to check first, the sections of an issue and the
labels, with additions for a data library. Issue templates: a report of a
value, an offered source, planned work and an OEP's tracking issue. AGENTS
gains a working agreement, the planned-work and downstream facts, and a
wider documentation-only exception. OEP 0 moves planned work to issues and
adds tracking issues, as solprop's SEP 0 did; the solprop fixtures are
recorded as frozen.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jtravs jtravs added the documentation Improvements or additions to documentation label Nov 4, 2026
Copilot AI balanced review requested due to automatic review settings November 4, 2026 10:54

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-04T10:55:46.691127Z d0ff0fd PR opened
🔒 Security Review ✅ Completed 2026-11-04T10:56:50.073897Z d0ff0fd PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@codecov

codecov Bot commented Nov 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@jtravs
jtravs merged commit 4e8a1f5 into main Nov 4, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants