[llvm] [llvm][Github] Add Pull Request template with link to Github docs/Discord/Forums (PR #71923)

David Spickett via llvm-commits llvm-commits at lists.llvm.org
Fri Nov 10 03:11:19 PST 2023


https://github.com/DavidSpickett created https://github.com/llvm/llvm-project/pull/71923

Inspired by Compiler Explorer's template, which just adds a hidden comment thanking the submitter, which I appreciated a lot when I contributed there.

Also by this post https://discourse.llvm.org/t/how-to-find-reviewers/74803.

This template gives us a way to direct folks who jump directly into making a PR to the help we have already written up.

I often assume (for better or worse) most GitHub hosted projects have similar processes, so if I was new to LLVM I likely wouldn't know about our docs either.

>From cf70247a23b43f824490b2abbd5a2818ff4f29b3 Mon Sep 17 00:00:00 2001
From: David Spickett <david.spickett at linaro.org>
Date: Fri, 10 Nov 2023 11:05:12 +0000
Subject: [PATCH] [llvm][Github] Add Pull Request template with link to Github
 docs

Inspired by Compiler Explorer's template, which just adds a hidden
comment thanking the submitter, which I appreciated a lot when I
contributed there.

Also by this post https://discourse.llvm.org/t/how-to-find-reviewers/74803.

This template gives us a way to direct folks who jump directly
into making a PR to the help we have already written up.

I often assume (for better or worse) most GitHub hosted projects
have similar processes, so if I was new to LLVM I likely
wouldn't know about our docs either.
---
 .github/pull_request_template.md | 10 ++++++++++
 1 file changed, 10 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 000000000000000..d0b32ea3e03aba4
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,10 @@
+<!-- THIS COMMENT IS NOT VISIBLE IN THE FINAL PR, BUT FEEL FREE TO REMOVE IT.
+Thankyou for submitting a Pull Request (PR) to the LLVM Project!
+
+If you have questions about the PR process, they may be answered by the LLVM GitHub User Guide:
+https://llvm.org/docs/GitHub.html
+
+If not, you can put your questions in a comment on the PR, or ask on the
+LLVM Discord (https://discord.com/invite/xS7Z362) or
+Discourse forums (https://discourse.llvm.org/).
+-->



More information about the llvm-commits mailing list