X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=CONTRIBUTING.md;h=ea9f2c194300507798ef377ea2f821035d82a5d1;hb=f2b5583f6084c68cf1f46a1554db7ee3f0252ec1;hp=c5dd3cd720548c8ea1ca9a3b7b3035ac099d7df8;hpb=05dc5e7d9566115416f6d0b84cc1c71bcf2c8cf4;p=rust.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c5dd3cd7205..ea9f2c19430 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 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,7 +142,7 @@ 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. +A default configuration requires 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)