]> git.lizzy.rs Git - rust.git/blobdiff - CONTRIBUTING.md
Remove SortedMap::iter_mut() since that allows to break the element sorting order...
[rust.git] / CONTRIBUTING.md
index 73d4188d695498e68e10388ce24b0e57bab27b11..e7041dcddc42c1e222b3b5a8b8e7d23f188ae2c0 100644 (file)
@@ -47,6 +47,12 @@ as it's possible that someone else has already reported your error. This doesn't
 always work, and sometimes it's hard to know what to search for, so consider this
 extra credit. We won't mind if you accidentally file a duplicate report.
 
+Similarly, to help others who encountered the bug find your issue,
+consider filing an issue with with a descriptive title, which contains information that might be unique to it.
+This can be the language or compiler feature used, the conditions that trigger the bug,
+or part of the error message if there is any.
+An example could be: **"impossible case reached" on lifetime inference for impl Trait in return position**.
+
 Opening an issue is as easy as following [this
 link](https://github.com/rust-lang/rust/issues/new) and filling out the fields.
 Here's a template that you can use to file a bug, though it's not necessary to
@@ -136,6 +142,8 @@ file. If you still have a `config.mk` file in your directory - from
 ### Building
 [building]: #building
 
+A default configuration shall use around 3.5 GB of disk space, whereas building a debug configuration may require more than 30 GB.
+
 Dependencies
 - [build dependencies](README.md#building-from-source)
 - `gdb` 6.2.0 minimum, 7.1 or later recommended for test builds