Skip to content

Commit 0579c8d

Browse files
committed
[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.
1 parent 7b1a058 commit 0579c8d

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

.github/pull_request_template.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!-- THIS COMMENT IS NOT VISIBLE IN THE FINAL PR, BUT FEEL FREE TO REMOVE IT.
2+
Thank you for submitting a Pull Request (PR) to the LLVM Project!
3+
4+
You can add reviewers by using the "Reviewers" section of the PR page.
5+
This requires that you have write permissions for the repository, so if this
6+
does not work for you, you can instead tag reviewers by name in a comment using
7+
"@<reviewer's GitHub username>".
8+
9+
If you have received no comments on your PR for a week, you can request a review
10+
by ‘ping’ing the PR by adding a comment “Ping”. The common courtesy ‘ping’
11+
rate is once a week. Please remember that you are asking for valuable time from
12+
other developers.
13+
14+
If you have further questions about the PR process, they may be answered by the
15+
LLVM GitHub User Guide: https://llvm.org/docs/GitHub.html
16+
17+
You can also ask questions in a comment on the PR, or ask on the
18+
LLVM Discord (https://discord.com/invite/xS7Z362) or
19+
Discourse forums (https://discourse.llvm.org/).
20+
-->

0 commit comments

Comments
 (0)