docs: Replace contributor boilerplate - #115
BenWestgate wants to merge 3 commits 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".
| or the PR description. Follow the [AI policy](docs/developer/AI_POLICY.md) for | ||
| authorship and disclosure. |
There was a problem hiding this comment.
The reviewed commit records Codex <codex@openai.com> as its author, but the AI policy linked here explicitly prohibits including agents as commit authors or co-authors and requires a responsible human author. Recreate the commit with the responsible human's identity before contribution.
AGENTS.md reference: AGENTS.md:L89-L93
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Still applies: both commits at current head are authored Codex <codex@openai.com>. Reauthor/squash as the responsible human.
Give contributors the actual editable dev install and CI checks, link the local security and AI policies, and remove inherited Bitcoin Core instructions that name nonexistent paths and workflows. This makes the documented on-ramp match the now-dependency-free test suite. Refs #38.
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".
Keep the concise contributor guide while retaining the original licensing and third-party attribution obligations. Point contributors to the actual LICENSE and LICENSES paths rather than the obsolete Bitcoin Core packaging path. refs #38
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.
Record the maintainer-authorized v1 library and GUI review-size caps in the contributor-facing policy. Budget changes require explicit review plus matching documentation and enforcement, and should not trigger unrelated pre-release refactors.\n\nRefs #38.
This branch has not been deployed
2 participants
Refs #38.
Replace inherited Bitcoin Core contribution instructions with the actual python-codex32 development setup, CI checks, local policy links, review expectations, and the maintainer-authorized v1 review budgets. The old document named paths and workflows that do not exist here; this change makes the contributor on-ramp reproducible after #7 removed the test-only bip32 dependency.
The contributor-facing budget contract is now explicit: the installed library stays below 5,200 logical review lines, GUI work uses a separate 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.
Verification: the documented editable .[dev] install succeeded in a disposable Python 3.14 environment; the assembled library/CLI branch passed 950 normal and 950 optimized tests. All new relative links resolve, and git diff --check passes on current head
b4bc364. This is documentation-only and does not claim to complete the final frozen-tip reviewer handoff.AI assistance was used to draft and verify this PR. Human review and authorship decisions remain with the maintainer.