From 000b9012349a2859bf38d72c661e7af346356ce2 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 3 Jun 2025 08:48:11 -0700 Subject: [PATCH 1/3] add PR template --- .github/pull_request_template.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..7031547f6 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,28 @@ +## Documentation changes + + + +Closes + +--- + +## 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 From 0b096e237b5a97ff7940d8389e8742035ac1e331 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 3 Jun 2025 09:00:40 -0700 Subject: [PATCH 2/3] github wanted different comment syntax --- .github/pull_request_template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7031547f6..b6c053327 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,8 @@ ## Documentation changes - +{/* Brief description of what's being updated */} -Closes +Closes {/* Linear ticket or GitHub issue */} --- From 0706489f74cf249aefc4f1dc10de12e09ad09c48 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 4 Jun 2025 14:01:54 -0700 Subject: [PATCH 3/3] remove comment syntax --- .github/pull_request_template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b6c053327..7066d4def 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,8 @@ ## Documentation changes -{/* Brief description of what's being updated */} +Brief description of what's being updated -Closes {/* Linear ticket or GitHub issue */} +Closes ---