diff options
| author | Niv Kaminer <nivkner@zoho.com> | 2018-04-21 12:08:01 +0300 |
|---|---|---|
| committer | Niv Kaminer <nivkner@zoho.com> | 2018-04-21 12:32:33 +0300 |
| commit | 79b11275965fe6dbd8d1ed52b44d7663ca4d2f95 (patch) | |
| tree | aa1e6b3759a980e54b3e2bc8c5fc6b5c8b90be56 | |
| parent | 9af69fe2320bde44b96d85d316a95083fb65c4b8 (diff) | |
| download | rust-79b11275965fe6dbd8d1ed52b44d7663ca4d2f95.tar.gz rust-79b11275965fe6dbd8d1ed52b44d7663ca4d2f95.zip | |
encourage descriptive issue titles
| -rw-r--r-- | CONTRIBUTING.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c5dd3cd7205..a6c66cf5d7e 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 with a descriptive title, which contains imformation 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 |