Skip to content

Commit 79b1127

Browse files
committed
encourage descriptive issue titles
1 parent 9af69fe commit 79b1127

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@ as it's possible that someone else has already reported your error. This doesn't
4747
always work, and sometimes it's hard to know what to search for, so consider this
4848
extra credit. We won't mind if you accidentally file a duplicate report.
4949

50+
Similarly, to help others who encountered the bug find your issue,
51+
consider filing an issue with with a descriptive title, which contains imformation that might be unique to it.
52+
This can be the language or compiler feature used, the conditions that trigger the bug,
53+
or part of the error message if there is any.
54+
An example could be: **"impossible case reached" on lifetime inference for impl Trait in return position**.
55+
5056
Opening an issue is as easy as following [this
5157
link](https://github.com/rust-lang/rust/issues/new) and filling out the fields.
5258
Here's a template that you can use to file a bug, though it's not necessary to

0 commit comments

Comments
 (0)