diff --git a/.github/PULL_REQUEST_TEMPLATE/dependency-update.md b/.github/PULL_REQUEST_TEMPLATE/dependency-update.md new file mode 100644 index 0000000..6c15e08 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/dependency-update.md @@ -0,0 +1,65 @@ +## Dependency Update + + + +## Update Summary + +| Field | Value | +|-------|-------| +| Tool | | +| Update Type | | +| Package Manager | | + +## Dependencies Updated + + + +| Package | From | To | Changelog | +|---------|------|----|-----------| +| `package-name` | `x.x.x` | `y.y.y` | [Link]() | + +## Risk Assessment + +- [ ] **Major version** - Breaking changes possible +- [ ] **Minor version** - New features, backward compatible +- [ ] **Patch version** - Bug fixes only +- [ ] **Security update** - Addresses CVE or vulnerability + +## Security Notes + + + +| CVE | Severity | Description | +|-----|----------|-------------| +| | | | + +## Compatibility Checklist + +- [ ] No breaking changes in updated dependencies +- [ ] Peer dependency requirements still satisfied +- [ ] Lock file updated correctly +- [ ] No conflicting version constraints + +## Testing + +- [ ] CI pipeline passes +- [ ] Unit tests pass +- [ ] Integration tests pass (if applicable) +- [ ] Local build succeeds + +## Auto-Merge Eligibility + + + +- [ ] Patch update from trusted source +- [ ] All CI checks passing +- [ ] No security advisories on new version +- [ ] Update is within allowed version range + +## Related PRs + + + +## Additional Notes + + diff --git a/.github/PULL_REQUEST_TEMPLATE/mcp-onboarding.md b/.github/PULL_REQUEST_TEMPLATE/mcp-onboarding.md new file mode 100644 index 0000000..6597cf8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/mcp-onboarding.md @@ -0,0 +1,78 @@ +## Summary + + + +## Repository Information + +| Field | Value | +|-------|-------| +| Repository | `owner/repo-name` | +| MCP Server Type | | +| Primary Language | | +| Transport(s) | | + +## Onboarding Method + +- [ ] Local setup (`just setup /path/to/repo`) +- [ ] Remote setup (`just setup-remote owner/repo`) +- [ ] Manual application + +## Bundle Components Applied + +### Root Files +- [ ] `SECURITY.md` - Security policy +- [ ] `CONTRIBUTING.md` - Contribution guidelines + +### .github/ Configuration +- [ ] `CODEOWNERS` - Code ownership rules +- [ ] `FUNDING.yml` - Sponsorship configuration +- [ ] `labels.yml` - Label definitions (70+) +- [ ] `pull_request_template.md` - PR template +- [ ] `release-drafter.yml` - Release notes config +- [ ] `dependabot.yml` - Dependency updates + +### Issue Templates (.github/ISSUE_TEMPLATE/) +- [ ] `mcp-server-discovery.yml` - Document new MCP servers +- [ ] `comparative-analysis.yml` - Compare similar servers +- [ ] `transport-implementation.yml` - Track transport work +- [ ] `rust-rewrite.yml` - Track Rust implementations +- [ ] `gap-identification.yml` - Document ecosystem gaps + +### Workflows (.github/workflows/) +- [ ] `label-sync.yml` - Sync labels from labels.yml +- [ ] `stale.yml` - Mark/close stale issues +- [ ] `hadolint.yml` - Lint Dockerfiles +- [ ] `dependency-review.yml` - Check for vulnerabilities +- [ ] `mdbook-build.yml` - Build/deploy documentation + +## Related Issues + + + +## Post-Setup Checklist + +- [ ] Updated `CODEOWNERS` with correct maintainer(s) +- [ ] Updated `FUNDING.yml` with correct sponsorship links +- [ ] Triggered label sync workflow (`gh workflow run label-sync.yml`) +- [ ] Repository added to [project:mcp-server-development](https://github.com/users/aRustyDev/projects/22) +- [ ] Verified all workflows are enabled and passing + +## Customizations + + + +| File | Customization | +|------|---------------| +| | | + +## Verification + +- [ ] All selected bundle files are present in the repository +- [ ] Labels synced successfully +- [ ] Workflows enabled and initial runs successful +- [ ] Issue templates appear in issue creation form +- [ ] PR template appears when creating new PRs + +## Additional Context + + diff --git a/.github/PULL_REQUEST_TEMPLATE/planning.md b/.github/PULL_REQUEST_TEMPLATE/planning.md new file mode 100644 index 0000000..e66d2c7 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/planning.md @@ -0,0 +1,77 @@ +## Summary + + + +## Planning Document Type + +- [ ] Plan (`.ai/plans/.md`) +- [ ] Phase document (`.ai/plans/phases/-phase-.md`) +- [ ] ADR - Architecture Decision Record (`.ai/docs/adr/*.md`) +- [ ] Index update (`.ai/INDEX.md`) +- [ ] Other planning artifact: + +## Documents Affected + +| File | Action | UUID | +|------|--------|------| +| `.ai/plans/example.md` | Added/Modified | `XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX` | + +## Related Issues + + + +## Frontmatter Checklist + +### Required Fields +- [ ] `id` - Valid UUID v4 (uppercase with hyphens) +- [ ] `title` - Descriptive document title +- [ ] `status` - Emoji prefix + status text (e.g., `⏳ In Progress`, `✅ Completed`) +- [ ] `date` - ISO 8601 format (YYYY-MM-DD) +- [ ] `author` - Author username + +### Optional Fields (if applicable) +- [ ] `related` - Array of related document UUIDs +- [ ] `children` - Array of child document UUIDs (for plans with phases) +- [ ] `depends_on` - Array of dependency UUIDs (for phase documents) +- [ ] `tags` - Array of categorization tags + +## Plan Structure (for new plans) + +- [ ] Problem statement clearly defined +- [ ] Goals/objectives listed +- [ ] Phases broken down (if multi-phase) +- [ ] Success criteria defined +- [ ] Dependencies identified + +## Cross-Reference Verification + +- [ ] Bidirectional links maintained (if A `related` to B, B `related` to A) +- [ ] Parent plan references child phases in `children` array +- [ ] Child phases reference parent in `related` array +- [ ] INDEX.md updated to include new documents + +## Phase Document Checklist (if applicable) + +- [ ] Phase numbered correctly in filename +- [ ] Tasks/steps clearly defined +- [ ] Acceptance criteria specified +- [ ] Dependencies on prior phases documented + +## ADR Checklist (if applicable) + +- [ ] Problem statement clearly articulated +- [ ] Decision documented +- [ ] Alternatives considered and documented +- [ ] Tradeoffs analyzed +- [ ] Implementation strategy outlined + +## Validation + +- [ ] All UUIDs are unique (not duplicated from other documents) +- [ ] All referenced UUIDs exist in the project +- [ ] Markdown renders correctly +- [ ] No broken internal links + +## Additional Context + +