Skip to content

Commit 28a3d00

Browse files
github-actionsseanmonstar
github-actions
authored andcommitted
doc: update contrib docs
1 parent 28e0bc6 commit 28a3d00

File tree

2 files changed

+34
-3
lines changed

2 files changed

+34
-3
lines changed

_contrib/contributing.md

+33-2
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,42 @@ layout: guide
44
hyper_path: CONTRIBUTING.md
55
---
66

7-
You want to contribute? You're awesome! Don't know where to start? Check the [list of easy issues](https://github.com/hyperium/hyper/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy).
7+
You want to contribute? You're awesome!
8+
9+
Contributions come in all shapes and sizes. Let's take a tour of some of the different wants you could contribute.
10+
11+
## [Code of Conduct](code-of-conduct.md)
12+
13+
Firstly, all interactions with the project need to abide by the code of conduct. This is to make sure everyone is treated kindly.
14+
15+
## [Issues](issues.md)
16+
17+
- **Filing an issue** is a contribution. We appreciate you letting us know about bugs you've found, and any information that you can provide that we can use to make hyper better. Without your filing it, we may not be aware of the bug.
18+
- [Triaging issues](issues.md#triaging) is a huge help. By your helping make issues better, the reporters can get answers sooner, and others can fix them with less effort. You can also volunteer as a frequent [triager](maintainers.md#triagers).
19+
- Discuss [feature requests][feat] (especially those marked [request-for-comment][b-rfc]).
20+
21+
[feat]: https://github.com/hyperium/hyper/issues?q=is%3Aissue+is%3Aopen+label%3AC-feature
22+
[b-rfc]: https://github.com/hyperium/hyper/issues?q=is%3Aissue+is%3Aopen+label%3AB-rfc
823

9-
[easy tag]: https://github.com/hyperium/hyper/issues?q=label%3AE-easy+is%3Aopen
1024

1125
## [Pull Requests](pull-requests.md)
1226

27+
By the way, consider checking the [list of easy issues](https://github.com/hyperium/hyper/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy) if you want to submit something.
28+
1329
- [Submitting a Pull Request](pull-requests.md#submitting-a-pull-request)
1430
- [Commit Guidelines](commits.md)
31+
32+
## Documentation
33+
34+
Improving hyper's documentation is a huge help for everyone who is trying to _use_ hyper.
35+
36+
- The API documentation (rendered at https://docs.rs/hyper) is stored as rustdoc comments directly in the source.
37+
- The main website has [tutorial-style guides](https://hyper.rs/guides). As of v1, they are currently in a [revamp](https://github.com/hyperium/hyper/issues/3411), and would greatly benefit from being filled out.
38+
39+
## Help
40+
41+
Helping others use hyper in their specific workflows is a very valuable way to contribute.
42+
43+
- Answer questions asked directly in hyper's [Discussions](https://github.com/hyperium/hyper/discussions).
44+
- Join our [Discord](https://discord.gg/kkwpueZ) and help those who show up with questions.
45+
- **Blog about hyper.** You writing a blog post about how you use hyper to do something specific, or how you contributed a new feature, or debugged something in it, is a great idea. Not all examples can fit in the hyper repo. Search engines will help people find their use cases on your blog. And you can describe processes in more depth or from a different perspective.

_contrib/maintainers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ To see what these roles do, and how to become one, look at [governance](./govern
1010

1111
- Eray Karatay (@programatik29)
1212
- Oddbjørn Grødem (@oddgrd)
13-
- Noah Kennedy (@Noah-Kennedy)
1413
- tottoto (@tottoto)
1514
- dswij (@dswij)
1615

@@ -24,6 +23,7 @@ To see what these roles do, and how to become one, look at [governance](./govern
2423
- Anthony Ramine (@nox)
2524
- David Pedersen (@davidpdrsn)
2625
- Adam Foltzer (@acfoltzer)
26+
- Noah Kennedy (@Noah-Kennedy)
2727

2828
<details>
2929
<summary>Emeriti</summary>

0 commit comments

Comments
 (0)