Add PR template, YAML issue forms, and CONTRIBUTING.md#113
Merged
Conversation
6 tasks
Agent-Logs-Url: https://github.com/dgenio/ChainWeaver/sessions/38ffab58-94aa-4aec-8dde-12fafdcec141 Co-authored-by: dgenio <12731907+dgenio@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add PR template, YAML issue forms, and CONTRIBUTING.md
Add PR template, YAML issue forms, and CONTRIBUTING.md
Apr 12, 2026
There was a problem hiding this comment.
Pull request overview
Adds standardized contribution infrastructure (PR template, YAML issue forms, and a contributor guide) to reduce review friction and align contributors with the repo’s canonical conventions.
Changes:
- Added root-level
CONTRIBUTING.mdwith setup, validation commands, and PR/issue guidance. - Added a PR template with required sections and a testing checklist.
- Added GitHub Issue Forms for bug reports and feature requests, plus issue template config.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
CONTRIBUTING.md |
New contributor guide covering setup, validation commands, conventions, and PR/issue process. |
.github/pull_request_template.md |
New PR template with required sections and a testing checklist. |
.github/ISSUE_TEMPLATE/bug_report.yml |
Structured bug report form (required repro + expected/actual + versions). |
.github/ISSUE_TEMPLATE/feature_request.yml |
Structured feature request form (description/use case required). |
.github/ISSUE_TEMPLATE/config.yml |
Enables blank issues in addition to forms. |
- CONTRIBUTING.md: change bare \pytest tests/ -v\ to \python -m pytest tests/ -v\ in the quick-start block (workflows.md Command-selection rules require python -m prefix) - .github/pull_request_template.md: add missing \ uff format --check\ step and use canonical scoped invocations (chainweaver/ tests/ examples/) for all four validation commands; replace bare \pytest\/\mypy\ with \python -m\ forms - tests/test_flow_execution.py: fix pre-existing Python 3.14 compatibility break — ZeroDivisionError message shortened from 'integer division or modulo by zero' to 'division by zero'; use any() to handle both Python versions
- Dep policy: replace 'only when strictly necessary' with 'judiciously — only when they deliver clear value and are well-maintained' to match AGENTS.md §1 and maintainer preference (deps are welcome with justification) - PR process: replace 'Split unrelated changes into separate PRs' with the nuanced AGENTS.md inv. 12 wording — a feature + tests + docs is one logical change; only split if genuinely unrelated - Dev setup: add python -m venv .venv step before pip install to prevent accidental global installs by new contributors
Conflict between our any()-based Python 3.14 workaround and main's cleaner record.error.detail set-membership check. Resolved in favour of main's approach — .detail is the structured attribute on FlowExecutionError, making the check more precise than str() comparison.
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.
No structured contribution infrastructure existed — no PR template, issue forms, or contributor guide — increasing review friction for both human and AI contributors.
Summary
Adds the full contribution scaffolding: PR template, YAML issue forms, and a root-level
CONTRIBUTING.md.Changes
.github/pull_request_template.md— PR template with Summary, Changes, Testing checklist (pytest/ruff/mypy), Related Issues, and Checklist sections; referencesAGENTS.mdas the canonical conventions source.github/ISSUE_TEMPLATE/bug_report.yml— structured bug form: description, steps to reproduce, expected/actual behavior (all required), Python version dropdown (3.10–3.13), ChainWeaver version, optional additional context.github/ISSUE_TEMPLATE/feature_request.yml— structured feature form: description and use case (required), proposed solution and alternatives (optional).github/ISSUE_TEMPLATE/config.yml—blank_issues_enabled: trueCONTRIBUTING.md— dev setup (pip install -e ".[dev]"), test/lint/typecheck commands, code style expectations (type annotations, Pydantic schemas, canonical vocabulary), PR/branch/commit conventions, issue reporting guidance, pointer toAGENTS.mdanddocs/agent-context/Testing
pytest)ruff check)mypy)Related Issues
Checklist
AGENTS.mdanddocs/agent-context/)