Skip to content

Commit a7ca652

Browse files
authored
Add issue templates (#265)
We get a _lot_ of issues that match the pattern of `FAILING_CONNECTION` or `FEAUTURE_REQUEST` which can't be solved in this repository. Document the common stuff to hopefully get fewer errant issues filed.
1 parent 19eed19 commit a7ca652

File tree

3 files changed

+69
-0
lines changed

3 files changed

+69
-0
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: I found a bug.
3+
about: You found that something which is expected to work, doesn't. The same
4+
capability works when using `dart:io` or `dart:html` directly.
5+
6+
---
7+
8+
<!--
9+
Please describe the bug and how to reproduce it.
10+
11+
Note that if the bug can also be reproduced when going through the interfaces
12+
provided by `dart:html or `dart:io` directly the bug should be filed against
13+
the Dart SDK: https://github.com/dart-lang/sdk/issues
14+
15+
A failure to make an http request is more often a problem with the environment
16+
than with the client.
17+
-->
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: An HTTP request fails when made through this client.
3+
about: You are attempting to make a GET or POST and getting an unexpected
4+
exception or status code.
5+
6+
---
7+
8+
**This is not the repository you want to file issues in!**
9+
10+
Note that a failing HTTP connection is almost certainly not caused by a bug in
11+
`package:http`.
12+
13+
This package is a wrapper around the clients [`dart:io` client][] and
14+
[`dart:hmtl` request][] to give a unified interface. Before filing a bug here,
15+
verify that the issue is not surfaced when using those interfaces directly.
16+
17+
[`dart:io` client]: https://api.dartlang.org/stable/dart-io/HttpClient-class.html
18+
[`dart:html` request]: https://api.dartlang.org/stable/dart-html/HttpRequest-class.html
19+
20+
# Common problems:
21+
22+
- A security policy prevents the connection.
23+
- Running in an emulator that does not have outside internet access.
24+
- Using Android and not requesting internet access in the [manifest][]
25+
26+
[manifest]: https://github.com/flutter/flutter/issues/29688
27+
28+
29+
None of these problems are influenced by the code in this repo.
30+
31+
# Diagnosing:
32+
33+
- Attempt the request outside of Dart, for instance in a browser or with `curl`.
34+
- Attempt the request with the `dart:io` or `dart:html` equivalent code paths.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: I'd like a new feature.
3+
about: You are using `package:http` and would like a new feature to make it
4+
easier to make http requests.
5+
6+
---
7+
8+
<!--
9+
Please describe the feature you'd like to see us implement along with a use
10+
case.
11+
12+
13+
Note that this package is designed to be cross-platform and we will only be
14+
able to add features which can be supported with _both_ `dart:io` and
15+
`dart:html`. If you're looking for a feature which is already supported by the
16+
`daart:io` HttpClient constructor you can construct one manually and pass it
17+
to the IOClient constructor directly.
18+
-->

0 commit comments

Comments
 (0)