Repository navigation
docs: Replace contributor boilerplate - #115
BenWestgate wants to merge 1 commit into
Conversation
BenWestgate
added
area: packaging/release
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a62e97bbe0
ℹ️ 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".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
a62e97b to
85fe944
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 85fe944fbf
ℹ️ 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".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
BenWestgate
left a comment
BenWestgate
left a comment
There was a problem hiding this comment.
AI-generated review (Codex), posted at the maintainer's request.
Not ACKing 8787bda yet: licensing is fixed, but the current commits are still authored by Codex <codex@openai.com>, contrary to the repository AI policy.
|
@codex review |
This comment has been minimized.
This comment has been minimized.
BenWestgate
left a comment
BenWestgate
left a comment
There was a problem hiding this comment.
AI-generated current-head review (Codex), performed at the maintainer's request.
Content ACK b4bc3646da24. The rewrite removes the inherited Bitcoin Core-only workflow and dead links, documents the actual .[dev] setup after the test-only secp256k1 dependency removal, restores contribution licensing/third-party attribution, and records the maintainer-authorized <5200 library / <2250 GUI review budgets without changing runtime behavior. Exact-head Python-package run 762 succeeded.
No documentation/content blocker remains. The existing authorship-policy thread is still valid because earlier commits in this PR remain authored by Codex <codex@openai.com>; responsible-human rewrite/squash is the remaining pre-integration step.
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b4bc3646da
ℹ️ 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".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
|
Codex Review: Didn't find any major issues. 🎉 Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
|
Take a look at https://github.com/BenWestgate/Bails/blob/master/CONTRIBUTING.md for inspiration. a similar adaptation of Core's doc has taken place for that project, some of which can be borrowed. Although we use Python here not Shell. |
BenWestgate
left a comment
BenWestgate
left a comment
There was a problem hiding this comment.
This is mostly slop. Use the new benwestgate/bails CONTRIBUTING.md as context for how to write python-codex32's. It should stay much closer to the bitcoin/bitcoin document merely removing the parts that do not apply here or adjusting them so they do rather than paraphrasing and deleting all of the original.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d093165c56
ℹ️ 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".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
BenWestgate
left a comment
BenWestgate
left a comment
There was a problem hiding this comment.
AI-assisted current-head review: not ACKing dcb5d47 yet. The maintainer feedback is still not addressed: this head still replaces most of Bitcoin Core's contributor workflow/review guidance with a short paraphrase. Keep the upstream structure and wording where applicable; remove or adapt only sections that do not apply here.
Keep the Bitcoin Core contributor guide structure and review philosophy while adapting only the setup, test, security, API, and review-budget details that differ for python-codex32. This addresses maintainer review on #115 without losing the documented .[dev] setup or project-specific release constraints. Refs #38
|
@codex review Please review current head |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3c13060cd8
ℹ️ 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".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
2d2c862 to
2511af8
Compare
|
@codex review Please review exact current head |
|
Codex Review: Didn't find any major issues. Chef's kiss. Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
BenWestgate
left a comment
BenWestgate
left a comment
There was a problem hiding this comment.
Codex current-head review at 2511af8: one existing P1 remains. The current commits are authored Codex <codex@openai.com>, contrary to the repository AI policy requiring the responsible human as author; reauthor/squash before merge.
2511af8 to
1e21ef0
Compare
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1e21ef041c
ℹ️ 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".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
CONTRIBUTING.md was inherited from Bitcoin Core and named paths and workflows this project doesn't have. Keep Core's structure and review philosophy, and adapt the parts that differ: the editable `.[dev]` install (quoted so it works in POSIX shells, PowerShell and cmd), the CI checks, security reporting, the AI policy, licensing and third-party attribution, and the maintainer-authorized review-size budgets. Refs #38 Claude-Session: https://claude.ai/code/session_01Q1TNm1YeYW8K9W2eBvxmCD
1e21ef0 to
7c5fe91
Compare
BenWestgate
left a comment
BenWestgate
left a comment
There was a problem hiding this comment.
AI-assisted current-head documentation review: ACK 7c5fe91. The previously reported AI commit-authorship blocker is resolved: this head is authored and committed by Ben Westgate. Contributor setup, project paths, and CI commands are project-specific. No remaining static blockers identified.
This branch has not been deployed
1 participant
Refs #38.
Keep the Bitcoin Core contributor guide’s workflow and peer-review structure, while replacing only the pieces that do not apply to python-codex32: the development setup, test commands, project documentation/security links, and v1 review budgets.
The documented setup uses Python 3.10–3.15 and
python -m pip install -e ".[dev], so it matches the dependency boundary after #7 removed the test-onlybip32/Coincurve chain. The contributor-facing budget contract remains explicit: the installed library stays below 5,200 logical review lines, GUI work uses the separately authorized 2,250-line budget once included in the candidate, and either cap changes only with explicit maintainer review/authorization plus matching documentation and enforcement. Unrelated refactors should not be taken solely to manufacture line-count headroom.Current head
2511af8restores the upstream-style contributor workflow, commit/rebase guidance, pull-request philosophy, decision-making, Concept/Approach ACK/NACK language, code-review vocabulary, reviewer guidance, copyright, and explicit Bitcoin Core attribution instead of replacing that material with a short paraphrase. Project-specific setup and policy changes are kept narrow. Codex’s review of the substantive rewrite found one broken GitHub task-list documentation URL; the one-line follow-up fixes that URL and the review thread is resolved.Prior verification established that the documented editable
.[dev]install succeeds in a disposable Python 3.14 environment and that the refreshed audit integration stack passes the normal/optimized suite, Ruff, strict mypy, and correction-constant verification. Exact-head Python-package run 821 has now completed successfully across the full current matrix after rerunning previously cancelled jobs. Codex reviewed exact current head2511af8after the one-line URL fix and reported no major issues.This PR is documentation-only and does not replace the final frozen-tip reviewer handoff required by #38. AI assistance was used to prepare and verify the change. The final follow-up commit is explicitly agent-authored and unsigned; responsible-human review/rewrite-squash and signed integration remain required.