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.
• Looking for something to work on? Filter issues by E-help-wanted.
• Planning to submit a PR? Read Pull Requests for the full workflow and required checks.
• Want to understand what the labels on issues mean? See Keeping track of issues and PRs.
• Interested in code review? See Reviewing Pull Requests.

Table of Contents

• Contributing in Issues
  • Asking for General Help
  • Submitting a Bug Report
  • Triaging a Bug Report
  • Resolving a Bug Report
• Pull Requests
  • Cargo Commands
  • Performing spellcheck on tokio codebase
  • Tests
    • Integration tests
    • Fuzz tests
    • Documentation tests
  • Benchmarks
  • Commits
    • Commit message guidelines
  • Opening the Pull Request
  • Discuss and update
  • Commit Squashing
• Reviewing Pull Requests
  • Review a bit at a time
  • Be aware of the person behind the code
  • Abandoned or Stalled Pull Requests
• How to specify crates dependencies versions
• Keeping track of issues and PRs
  • Area
  • Category
  • Calls for participation
  • Module
  • Topic