Skip to content

Commit

Permalink
doc: update contrib docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions authored and seanmonstar committed Dec 16, 2023
1 parent de51938 commit 39bf4fc
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions _contrib/issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,16 @@ These labels indicate an issue is "blocked" for some reason.
- **B-rfc**: request for comments. More discussion is needed to explore the design.
- **B-upstream**: waiting on something in a dependency or the compiler.

### Category

The category marks what kind of issue this is.

- **C-bug**: something is wrong, this is bad!
- **C-feature**: this is a new feature request, adding something new.
- **C-performance**: make existing working code go faster.
- **C-refactor**: improve internal code to help readability and maintenance.
- **C-chore**: a general chore or maintenance task.

### Effort

The effort labels are a best-guess at roughly how much effort and knowledge of hyper is needed to accomplish the task.
Expand All @@ -103,14 +113,6 @@ The effort labels are a best-guess at roughly how much effort and knowledge of h
- **E-medium**: some knowledge of how hyper internals work would be useful.
- **E-hard**: likely requires a deeper understanding of how hyper internals work.

### Severity

The severity marks how _severe_ the issue is. Note this isn't "importance" or "priority".

- **S-bug**: something is wrong, this is bad!
- **S-feature**: this is a new feature request, adding something new.
- **S-performance**: make existing working code go faster.
- **S-refactor**: improve internal code to help readability and maintenance.

[issues]: https://github.com/hyperium/hyper/issues
[COC]: ./code-of-conduct.md
Expand Down

0 comments on commit 39bf4fc

Please sign in to comment.