Repository navigation
Feature: GitHub PR template - #41
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a pull request template so PR descriptions are consistent and reviewers see the relevant checks. GitHub's web UI can't choose between several templates, so this is a single template with one section per change type (feature, bug fix, tests, docs, refactor/style, CI/CD, breaking changes/dependencies). Contributors delete the sections that don't apply. AGENTS.md now points to the template and adds high-level directives for writing PRs.
Related issues
None
General checklist
HISTORY.mdupdated under[Unreleased](or N/A: no user-facing change). N/A: contributor tooling only📚 Documentation
What changed:
.github/pull_request_template.md(new): a shared header (summary, related issues, general checklist), then optional per-type sections. Each section has guidance in HTML comments and a short ProteoPy-specific checklist. Detailed coding rules stay in AGENTS.md and are referenced, not repeated.AGENTS.md, Commit and Pull Request Guidelines: refers to the template and adds directives on correctness, conciseness, readability, scope and impact. Removes the old "Test/lint outputs" requirement, since CI runs the checks and the template only asks for a checkbox.Sphinx build runs without new warnings. N/A: no Sphinx sources touched
Notebooks re-run top to bottom; outputs are current. N/A: no notebooks touched
Examples use
import proteopy as prNotes for reviewers
main.SKIP=pytest); all lint hooks passed.🤖 Generated with Claude Code