Skip to content

Commit e8cccce

Browse files
committed
docs(contrib): add ISSUES doc
1 parent 9ee7323 commit e8cccce

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

docs/ISSUES.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Issues
2+
3+
The [issue tracker][issues] for hyper is where we track all features, bugs, and discuss proposals.
4+
5+
## Labels
6+
7+
Issues are organized with a set of labels. Most labels follow a system of being prefixed by a "type".
8+
9+
### Area
10+
11+
The area labels describe what part of hyper is relevant.
12+
13+
- **A-body**: streaming request and response bodies.
14+
- **A-client**: the HTTP client.
15+
- **A-dependencies**: library dependencies.
16+
- **A-docs**: documentation.
17+
- **A-error**: error reporting and types.
18+
- **A-ffi**: the C API.
19+
- **A-http1**: the HTTP/1 specifics.
20+
- **A-http2**: the HTTP/2 specifics.
21+
- **A-server**: the HTTP server.
22+
- **A-tests**: the unit and integration tests.
23+
24+
### Blocked
25+
26+
These labels indicate an issue is "blocked" for some reason.
27+
28+
- **B-breaking-change**: a breaking change that is waiting for the next semver-compatible release.
29+
- **B-rfc**: request for comments. More discussion is needed to explore the design.
30+
- **B-upstream**: waiting on something in a dependency or the compiler.
31+
32+
### Effort
33+
34+
The effort labels are a best-guess at roughly how much effort and knowledge of hyper is needed to accomplish the task.
35+
36+
- **E-easy**: a great starting point for a new contributor.
37+
- **E-medium**: some knowledge of how hyper internals work would be useful.
38+
- **E-hard**: likely requires a deeper understanding of how hyper internals work.
39+
40+
### Severity
41+
42+
The severity marks how _severe_ the issue is. Note this isn't "importance" or "priority".
43+
44+
- **S-bug**: something is wrong, this is bad!
45+
- **S-feature**: this is a new feature request, adding something new.
46+
- **S-performance**: make existing working code go faster.
47+
- **S-refactor**: improve internal code to help readability and maintenance.
48+
49+
[issues]: https://github.com/hyperium/hyper/issues

0 commit comments

Comments
 (0)