Skip to content

Feature: GitHub PR template - #41

Merged
idf-io merged 2 commits into
mainfrom
feature/gh_pr_template
Oct 6, 2026
Merged

idf-io merged 2 commits into
mainfrom
feature/gh_pr_template

Conversation

@idf-io

@idf-io idf-io commented Oct 6, 2026 •

Copy link
Copy Markdown
Collaborator

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

  • Branch name and commit subjects follow the repo conventions
  • HISTORY.md updated under [Unreleased] (or N/A: no user-facing change). N/A: contributor tooling only
  • CI is green (flake8, pylint, pytest)

📚 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 pr


Notes for reviewers

  • The template only takes effect once merged into main.
  • AGENTS.md contains the Commit and Pull Request Guidelines section twice (along with several other duplicated sections). Both copies were updated identically. Removing the duplication is left for a separate PR.
  • No Python files changed. The pre-push pytest hook was skipped locally (SKIP=pytest); all lint hooks passed.

🤖 Generated with Claude Code

idf-io and others added 2 commits October 6, 2026 18:32
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 6, 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-10-06T16:38:50.081399Z ae5a6ec 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.

@idf-io
idf-io merged commit 9423311 into main Oct 6, 2026
7 checks passed
@idf-io
idf-io deleted the feature/gh_pr_template branch October 6, 2026 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant