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

Update reference to CONTRIBUTING.md #74037

Merged
merged 1 commit into from
Jul 16, 2020
Merged

Update reference to CONTRIBUTING.md #74037

merged 1 commit into from
Jul 16, 2020
+13 −5

Conversation

JohnTitor
Copy link
Member

@JohnTitor JohnTitor commented Jul 4, 2020 •
edited
Loading

CONTRIBUTING.md has been migrated to the rustc-dev-guide but some still refer there.
Update them with the appropriate links.

Fixes #74253

@rust-highfive
Copy link
Collaborator

r? @Mark-Simulacrum

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 4, 2020
ehuss
ehuss reviewed Jul 4, 2020
View reviewed changes
Copy link
Contributor

@ehuss ehuss left a comment

Choose a reason for hiding this comment

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

Since all previous compilers will be reporting a semi-broken link, perhaps it would be a good idea to add a small ## Bug reports section back to CONTRIBUTING.md that linked to the specific section in the guide (https://rustc-dev-guide.rust-lang.org/contributing.html#bug-reports)?

src/libstd/lib.rs Outdated Show resolved Hide resolved
@JohnTitor
Copy link
Member Author

JohnTitor commented Jul 4, 2020 •
edited
Loading

perhaps it would be a good idea to add a small ## Bug reports section back to CONTRIBUTING.md that linked to the specific section in the guide (rustc-dev-guide.rust-lang.org/contributing.html#bug-reports)?

I agree with this but the link here is still useful for me. So, we could use the issue template link for further compiler errors and also use that section for previous ones, I think.

@JohnTitor
Copy link
Member Author

So, the problem here is that someone who sees the ICE message visits the CONTRIBUTING.md first, then they visit the getting started page following "To get started, read the Getting Started guide in the rustc-dev-guide.", and they cannot find any instruction about bug reports there (context: https://rust-lang.zulipchat.com/#narrow/stream/122651-general/topic/Reporting.20an.20ICE).
Given this situation, for the previous message, we should prepare the bug reports section on the getting-started page or tell them to visit https://rustc-dev-guide.rust-lang.org/contributing.html, not the getting-started.html.

@JohnTitor
Copy link
Member Author

cc @mark-i-m I'd love to hear your opinion.

@JohnTitor
Copy link
Member Author

Okay, updated the CONTRIBUTING.md here.

@mark-i-m
Copy link
Member

mark-i-m commented Jul 7, 2020

Sorry for the delay... I'm a bit low on bandwidth these days.

I think pointing to the template in the error message and then adding a section to CONTRIBUTING.md that points to the relevant section in the guide seems reasonable.

@ehuss ehuss mentioned this pull request Jul 11, 2020
Closed
@JohnTitor
Copy link
Member Author

JohnTitor commented Jul 13, 2020 •
edited
Loading

Ping @Mark-Simulacrum, I think it's ready to review/merge.

Mark-Simulacrum
Mark-Simulacrum approved these changes Jul 15, 2020
View reviewed changes
src/librustc_driver/lib.rs
const BUG_REPORT_URL: &str = "https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.\
md#bug-reports";
const BUG_REPORT_URL: &str = "https://github.com/rust-lang/rust/issues/new\
?labels=C-bug%2C+I-ICE%2C+T-compiler&template=ice.md";
Copy link
Member

Choose a reason for hiding this comment

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

Hm this looks like a pretty annoying URL to output. I'm of half a mind to say we should create a redirect at, say, rust-lang.org/compiler-bug-report so we can readily update things in the future. It seems fine for the time being though.

Copy link
Member

Choose a reason for hiding this comment

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

That's a good idea

@Mark-Simulacrum
Copy link
Member

@bors r+ rollup

Thanks! Sorry for the slow review here.

@bors
Copy link
Contributor

bors commented Jul 15, 2020

📌 Commit 85072e3 has been approved by Mark-Simulacrum

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 15, 2020
Manishearth added a commit to Manishearth/rust that referenced this pull request Jul 16, 2020
@Manishearth
Rollup merge of rust-lang#74037 - JohnTitor:contributing-md, r=Mark-S…
ead1272 
…imulacrum

Update reference to CONTRIBUTING.md

CONTRIBUTING.md has been migrated to the rustc-dev-guide but some still refer there.
Update them with the appropriate links.

Fixes rust-lang#74253
@Manishearth Manishearth mentioned this pull request Jul 16, 2020
Closed
@Manishearth Manishearth mentioned this pull request Jul 16, 2020
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 16, 2020
@bors
Auto merge of rust-lang#74388 - Manishearth:rollup-i7iueu8, r=Manishe…
4cd0ee9 
…arth

Rollup of 7 pull requests

Successful merges:

 - rust-lang#73421 (Clarify effect of orphan rule changes on From/Into)
 - rust-lang#74037 (Update reference to CONTRIBUTING.md)
 - rust-lang#74203 (Enforce the static symbol order.)
 - rust-lang#74295 (Add and fix BTreeMap comments)
 - rust-lang#74352 (Use local links in the alloc docs.)
 - rust-lang#74377 (Move libstd's default feature to libtest)
 - rust-lang#74381 (Update docs for str::as_bytes_mut.)

Failed merges:

r? @ghost
@bors bors merged commit e598ee5 into rust-lang:master Jul 16, 2020
@JohnTitor JohnTitor deleted the contributing-md branch July 16, 2020 10:23
@cuviper cuviper added this to the 1.47.0 milestone May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mark-i-m mark-i-m mark-i-m left review comments

@ehuss ehuss ehuss left review comments

@Mark-Simulacrum Mark-Simulacrum Mark-Simulacrum approved these changes

Assignees

@Mark-Simulacrum Mark-Simulacrum

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
1.47.0
Development

Successfully merging this pull request may close these issues.

Compiler panic gives a dead bug report link
7 participants
@JohnTitor @rust-highfive @mark-i-m @Mark-Simulacrum @bors @ehuss @cuviper