mirror of
https://github.com/tokio-rs/tokio.git
synced 2025-12-27 16:37:25 +00:00
46 lines
2.7 KiB
Markdown
46 lines
2.7 KiB
Markdown
# Contributing
|
|
|
|
This guide will help you get started. **Do not let this guide intimidate you**.
|
|
It should be considered a map to help you navigate the process.
|
|
|
|
## Quick start
|
|
|
|
If you are unsure where to begin, use the following guides:
|
|
|
|
- Want to report or triage a bug? Start with [Contributing in Issues](contributing-in-issues.md).
|
|
- Looking for something to work on? Filter issues by [`E-help-wanted`](https://github.com/tokio-rs/tokio/labels/E-help-wanted).
|
|
- Planning to submit a PR? Read [Pull Requests](pull-requests.md) for the full workflow and required checks.
|
|
- Want to understand what the labels on issues mean? See [Keeping track of issues and PRs](keeping-track-of-issues-and-prs.md).
|
|
- Interested in code review? See [Reviewing Pull Requests](reviewing-pull-requests.md).
|
|
|
|
## Table of Contents
|
|
|
|
- [Contributing in Issues](contributing-in-issues.md)
|
|
- [Asking for General Help](contributing-in-issues.md#asking-for-general-help)
|
|
- [Submitting a Bug Report](contributing-in-issues.md#submitting-a-bug-report)
|
|
- [Triaging a Bug Report](contributing-in-issues.md#triaging-a-bug-report)
|
|
- [Resolving a Bug Report](contributing-in-issues.md#resolving-a-bug-report)
|
|
- [Pull Requests](pull-requests.md)
|
|
- [Cargo Commands](pull-requests.md#cargo-commands)
|
|
- [Performing spellcheck on tokio codebase](pull-requests.md#performing-spellcheck-on-tokio-codebase)
|
|
- [Tests](pull-requests.md#tests)
|
|
- [Integration tests](pull-requests.md#integration-tests)
|
|
- [Fuzz tests](pull-requests.md#fuzz-tests)
|
|
- [Documentation tests](pull-requests.md#documentation-tests)
|
|
- [Benchmarks](pull-requests.md#benchmarks)
|
|
- [Commits](pull-requests.md#commits)
|
|
- [Commit message guidelines](pull-requests.md#commit-message-guidelines)
|
|
- [Opening the Pull Request](pull-requests.md#opening-the-pull-request)
|
|
- [Discuss and update](pull-requests.md#discuss-and-update)
|
|
- [Commit Squashing](pull-requests.md#commit-squashing)
|
|
- [Reviewing Pull Requests](reviewing-pull-requests.md)
|
|
- [Review a bit at a time](reviewing-pull-requests.md#review-a-bit-at-a-time)
|
|
- [Be aware of the person behind the code](reviewing-pull-requests.md#be-aware-of-the-person-behind-the-code)
|
|
- [Abandoned or Stalled Pull Requests](reviewing-pull-requests.md#abandoned-or-stalled-pull-requests)
|
|
- [Keeping track of issues and PRs](keeping-track-of-issues-and-prs.md)
|
|
- [Area](keeping-track-of-issues-and-prs.md#area)
|
|
- [Category](keeping-track-of-issues-and-prs.md#category)
|
|
- [Calls for participation](keeping-track-of-issues-and-prs.md#calls-for-participation)
|
|
- [Module](keeping-track-of-issues-and-prs.md#module)
|
|
- [Topic](keeping-track-of-issues-and-prs.md#topic)
|