PULL_REQUEST_TEMPLATE.md

Summary

[Provide a brief description of the changes in this PR]

Type of Change:

• Documentation update
• New content (curriculum, examples, templates)
• Bug fix (typo, broken link, incorrect information)
• Enhancement (improved clarity, additional examples)

---

Related Issue

Closes #[issue number]

---

Changes Made

[List the specific files changed and what was modified]

• 01-curriculum/01-requirements-engineering.md - Added section on stakeholder interviews
• 02-reserve-easy-project/02-specs/BRD-v1.0.md - Fixed formatting in success metrics table
• 03-toolkit/templates/user-story-card.md - Updated acceptance criteria example

---

Checklist

Content Quality

• All markdown files render correctly (no broken formatting)
• Code blocks have appropriate language tags (e.g., sql, yaml)
• Mermaid diagrams render without syntax errors
• All internal links work (tested locally)
• All external links are valid
• Images and media are properly embedded
• File and directory names follow naming conventions (lowercase, hyphens)

Accuracy

• Technical information is correct (SQL queries run, API specs are valid)
• Examples are realistic and reflect current industry practices (2026 standards)
• No placeholder content (e.g., "TODO", "Lorem ipsum", "[Insert text]")
• Terminology is consistent across related documents

Pedagogy (For Curriculum Changes)

• Content is beginner-friendly (defines jargon, provides context)
• Includes practical examples (not just theory)
• Has exercises or practice opportunities
• Clear learning objectives stated
• Appropriate difficulty level for target audience

Compliance

• No sensitive information (API keys, passwords, real user data)
• No copyrighted material used without attribution
• Follows inclusive language guidelines

---

Testing Done

[Describe how you verified your changes]

• Previewed all changed markdown files locally
• Ran SQL queries against test database (if applicable)
• Validated YAML/JSON syntax (if applicable)
• Checked Mermaid diagrams in Mermaid Live Editor
• Tested links with markdown-link-check (if available)

---

Screenshots (Optional)

[If your changes affect visual presentation, include before/after screenshots]

---

Additional Notes

[Any context the reviewer should know? Design decisions, trade-offs, etc.]

---

Reviewer Guidance

What should reviewers focus on?

[e.g., "Please verify the SQL query logic in funnel_analysis.sql" or "Check if the tone is appropriate for beginners"]