Write dev/contributor docs
Open
Nobody has claimed this yet.
A-docs
E-easy
- Dominant language
- Rust
- Stars
- 16.3k
- Forks
- 1.8k
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 14
Description
- Update
CONTRIBUTING.md- Move most content into
devfolder documents
- Move most content into
- Make
docsfolder with developer docs- README as an index file
- Charter and Tenets
- Conduct
- Roadmap
- Issues, labels
- Pull requests
- Committing
- Testing
- MSRV (Minimum Supported Rust Version)
- Release Process
- Design
- Feature flags
- private-in-public types as
impl Trait - Poll functions vs
async
- Governance
- Render dev guide on https://hyper.rs/contrib
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
Review CONTRIBUTING.md and the existing documents in the dev folder, then inspect the rendered developer guide at https://hyper.rs/contrib. Create the docs folder with a README index and complete the unchecked topics: pull requests, testing, release process, and the listed design subjects. Done means the remaining developer documentation is present and the guide is rendered consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100