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

Improve major change opening comment #1914

Merged
merged 1 commit into from
Mar 7, 2025
Merged

Improve major change opening comment #1914

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
52 changes: 23 additions & 29 deletions src/handlers/major_change.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,35 +259,29 @@ async fn handle(
if new_proposal {
let topic_url = zulip_req.url();
let comment = format!(
"> [!IMPORTANT] \n\
> This issue is *not meant to be used for technical discussion*. \
There is a **Zulip [stream]** for that. Use this issue to leave \
procedural comments, such as volunteering to review, indicating that you \
second the proposal (or third, etc), or raising a concern that you would \
like to be addressed. \
\n\n \
Concerns or objections to the proposal should be discussed on Zulip and formally registered \
here by adding a comment with the following syntax: \
\n \
``` \
\n \
@rfcbot concern reason-for-concern \
\n \
<description of the concern> \
\n \
``` \
\n \
Concerns can be lifted with: \
\n \
``` \
\n \
@rfcbot resolve reason-for-concern \
\n \
``` \
\n\n \
See documentation at [https://forge.rust-lang.org](https://forge.rust-lang.org/compiler/mcp.html#what-kinds-of-comments-should-go-on-the-tracking-issue-in-compiler-team-repo) \
\n\n{} \
\n\n[stream]: {}",
r#"> [!IMPORTANT]
> This issue is *not meant to be used for technical discussion*. There is a **Zulip [stream]** for that.
> Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.

<details>
<summary>Concerns or objections can formally be registered here by adding a comment.</summary>
Copy link
Contributor

Choose a reason for hiding this comment

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

small suggestion: I would put this sentence outside the <detail> tag or it will probably end up being less readable in the email notification.

Copy link
Member Author

@Urgau Urgau Mar 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I hacked the same HTML generated in the UI in an email (it's probably not exactly the same, but good enough), and it looks fine, same as in the web UI.
image
image

Copy link
Contributor

@apiraino apiraino Mar 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Important

This issue is not meant to be used for technical discussion. There is a Zulip stream for that.
Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.

Concerns or objections can formally be registered here by adding a comment. 

@rfcbot concern reason-for-concern
<description of the concern>

Concerns can be lifted with:

@rfcbot resolve reason-for-concern

See documentation at https://forge.rust-lang.org

r? @apiraino

Copy link
Contributor

Choose a reason for hiding this comment

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

I hope it will look good also on text only emails. I'll report it it's not the case.

<p>

```
@rfcbot concern reason-for-concern
<description of the concern>
```
Concerns can be lifted with:
```
@rfcbot resolve reason-for-concern
```
See documentation at [https://forge.rust-lang.org](https://forge.rust-lang.org/compiler/mcp.html#what-kinds-of-comments-should-go-on-the-tracking-issue-in-compiler-team-repo)
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here, I think its place is better outside the collapsible text (to avoid being "hidden")


</p>
</details>
{}

[stream]: {}"#,
config.open_extra_text.as_deref().unwrap_or_default(),
topic_url
);
Expand Down