swift-server / swift-server/async-http-client
README could be more in depth
Open
Nobody has claimed this yet.
kind/enhancement
- Dominant language
- Swift
- Stars
- 1.1k
- Forks
- 156
- PR merge metrics
- No merged PRs in 30d
Description
It would be nice if the README had a few more examples for common situations, as an example, post of a Data body isn't included (and there aren't other docs, as far as I can see)?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the README and its existing usage examples. Add examples for common situations, including posting a Data body, and consider whether the README sufficiently covers usage because no other documentation is identified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100