summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorNiv Kaminer <nivkner@zoho.com>2018-04-21 12:08:01 +0300
committerNiv Kaminer <nivkner@zoho.com>2018-04-21 12:32:33 +0300
commit79b11275965fe6dbd8d1ed52b44d7663ca4d2f95 (patch)
treeaa1e6b3759a980e54b3e2bc8c5fc6b5c8b90be56 /CONTRIBUTING.md
parentAuto merge of #50080 - klnusbaum:edition_49591, r=Manishearth (diff)
downloadgrust-79b11275965fe6dbd8d1ed52b44d7663ca4d2f95.tar.gz
grust-79b11275965fe6dbd8d1ed52b44d7663ca4d2f95.tar.bz2
grust-79b11275965fe6dbd8d1ed52b44d7663ca4d2f95.tar.xz
encourage descriptive issue titles
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c5dd3cd720..a6c66cf5d7 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
47always work, and sometimes it's hard to know what to search for, so consider this 47always work, and sometimes it's hard to know what to search for, so consider this
48extra credit. We won't mind if you accidentally file a duplicate report. 48extra credit. We won't mind if you accidentally file a duplicate report.
49 49
50Similarly, to help others who encountered the bug find your issue,
51consider filing an issue with with a descriptive title, which contains imformation that might be unique to it.
52This can be the language or compiler feature used, the conditions that trigger the bug,
53or part of the error message if there is any.
54An example could be: **"impossible case reached" on lifetime inference for impl Trait in return position**.
55
50Opening an issue is as easy as following [this 56Opening an issue is as easy as following [this
51link](https://github.com/rust-lang/rust/issues/new) and filling out the fields. 57link](https://github.com/rust-lang/rust/issues/new) and filling out the fields.
52Here's a template that you can use to file a bug, though it's not necessary to 58Here's a template that you can use to file a bug, though it's not necessary to