From ce063921b5a5ed964bf87dc572da992004ca2059 Mon Sep 17 00:00:00 2001 From: nora <48135649+Noratrieb@users.noreply.github.com> Date: Thu, 24 Oct 2024 19:09:25 +0200 Subject: [PATCH 1/5] Add PR template encouraging inline comments over normal comments RFC threads are known for turning into huge messes once many comments arrive. One among many reasons for this is that the comments are entirely disorganized, which makes it very hard to keep track. I propose adding a warning the PR template that will strongly encourage people to leave inline review comments. These are significantly easier to keep track of (and can be resolved, hiding them!). --- .github/PULL_REQUEST_TEMPLATE.md | 11 +++++++++++ 1 file changed, 11 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 00000000000..f229abfaed5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ + + + + +[Rendered](LINK-TO-MARKDOWN-FILE) + +> [!IMPORTANT] +> When responding to RFCs, try to use inline review comments instead of direct comments for normal comments +> and keep normal comments for procedural matters like starting FCPs. +> +> This keeps the discussion more organized. From f1d554e8dd1b97ee7a4a99e16af38dc5fd25dcd5 Mon Sep 17 00:00:00 2001 From: nora <48135649+Noratrieb@users.noreply.github.com> Date: Thu, 24 Oct 2024 19:22:25 +0200 Subject: [PATCH 2/5] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f229abfaed5..066d5086e61 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,5 @@ - - -[Rendered](LINK-TO-MARKDOWN-FILE) > [!IMPORTANT] > When responding to RFCs, try to use inline review comments instead of direct comments for normal comments From 9504a839ca04adb9656e24ea48c035aa28068e93 Mon Sep 17 00:00:00 2001 From: nora <48135649+Noratrieb@users.noreply.github.com> Date: Thu, 24 Oct 2024 21:19:33 +0200 Subject: [PATCH 3/5] Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Eric Huss --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 066d5086e61..7c04d28ce57 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,5 @@ - + > [!IMPORTANT] > When responding to RFCs, try to use inline review comments instead of direct comments for normal comments From 44053e91419031c118db742ab2d4f5c011728c1c Mon Sep 17 00:00:00 2001 From: nora <48135649+Noratrieb@users.noreply.github.com> Date: Thu, 24 Oct 2024 23:01:35 +0200 Subject: [PATCH 4/5] Note on review comments for entire file --- .github/PULL_REQUEST_TEMPLATE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7c04d28ce57..9e5281f66d1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,7 +2,8 @@ > [!IMPORTANT] -> When responding to RFCs, try to use inline review comments instead of direct comments for normal comments +> When responding to RFCs, try to use inline review comments (it is possible to leave an inline review comment for the entire file at the top) +> instead of direct comments for normal comments > and keep normal comments for procedural matters like starting FCPs. > > This keeps the discussion more organized. From ecdb951fe3b5822a0c76ad5f630b3a50692954eb Mon Sep 17 00:00:00 2001 From: nora <48135649+Noratrieb@users.noreply.github.com> Date: Thu, 24 Oct 2024 23:02:38 +0200 Subject: [PATCH 5/5] line wrapping to make it look good --- .github/PULL_REQUEST_TEMPLATE.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9e5281f66d1..28b0e94d6dd 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,8 +2,6 @@ > [!IMPORTANT] -> When responding to RFCs, try to use inline review comments (it is possible to leave an inline review comment for the entire file at the top) -> instead of direct comments for normal comments -> and keep normal comments for procedural matters like starting FCPs. +> When responding to RFCs, try to use inline review comments (it is possible to leave an inline review comment for the entire file at the top) instead of direct comments for normal comments and keep normal comments for procedural matters like starting FCPs. > > This keeps the discussion more organized.