Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add PR template encouraging inline comments over normal comments #3717

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add PR template encouraging inline comments over normal comments #3717

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ce06392
Add PR template encouraging inline comments over normal comments
Noratrieb Oct 24, 2024
f1d554e
Update PULL_REQUEST_TEMPLATE.md
Noratrieb Oct 24, 2024
9504a83
Update .github/PULL_REQUEST_TEMPLATE.md
Noratrieb Oct 24, 2024
44053e9
Note on review comments for entire file
Noratrieb Oct 24, 2024
ecdb951
line wrapping to make it look good
Noratrieb Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usually whatever I want to say isn't about a specific line of the text, it's about something not in the text or it's about the entire direction of th text as a whole.

@Lokathor Comments can be added to a file directly.

Also, and this is a minor thing but it's a thing, inline comments have worse preview text when you get the notification about them.

Agree though in general notification previews on GitHub are terrible 🤢

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a sentence about it

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!-- Thank you for trying to improve Rust through the RFC process! -->
<!-- Please add a short summary of your RFC below -->

> [!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.