Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Submitting Pull Requests

Before Submitting

  1. Fork the repository on GitHub
  2. Create a feature branch from main
  3. Make your changes with clear, focused commits
  4. Test your changes - run cargo test --workspace
  5. Lint your code - run cargo clippy --workspace
  6. Format your code - run cargo fmt

Creating the Pull Request

  1. Push your branch to your fork
  2. Open a pull request on GitHub
  3. Fill in the PR template with:
    • Description of changes
    • Related issues
    • Testing done
  4. Wait for review - maintainers will review your PR

After Submission

  • Respond to feedback - address review comments promptly
  • Keep your PR updated - rebase if needed
  • Be patient - reviews may take time

PR Guidelines

  • Keep PRs focused on a single feature or fix
  • Write clear commit messages
  • Update documentation if needed
  • Add tests for new functionality