diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..b6c053327 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,28 @@ +## Documentation changes + +{/* Brief description of what's being updated */} + +Closes {/* Linear ticket or GitHub issue */} + +--- + +## For Reviewers + +When reviewing documentation PRs, please consider: + +### ✅ Technical accuracy +- [ ] Code examples work as written +- [ ] Commands and configurations are correct +- [ ] Links resolve to the right destinations +- [ ] Prerequisites and requirements are accurate + +### ✅ Clarity and completeness +- [ ] Instructions are clear and easy to follow +- [ ] Steps are in logical order +- [ ] Nothing important is missing +- [ ] Examples help illustrate the concepts + +### ✅ User experience +- [ ] A new user could follow these docs successfully +- [ ] Common gotchas or edge cases are addressed +- [ ] Error messages or troubleshooting guidance is helpful