Skip to content

Team Resources

This page provides links to team documentation, communication channels, and collaboration tools.

Team Documentation

Communication

Slack

Primary Channel: #engineer-bug-requests for: - Bug reports and engineering communication - Team coordination and technical discussions - Use threads, tag relevant team members - Include context/error messages for bugs - Link to Linear tickets

Linear

Purpose: Task and project tracking. View all projects and issues via Linear Projects.

Linear is the primary tool for: - Task management and tracking - Project planning, bug tracking, and feature requests - Sprint planning

Best Practices: - Create Linear tickets for all work items - Link Linear tickets in PR descriptions - Use Linear for TODO comments: # TODO [ORB-XXX]: Description - Update ticket status as work progresses - Reference Linear issues when discussing bugs or features

Pull Request Process

Approval Requirements

CRITICAL: Always ensure someone approves your PR before merging. We practice cross-validation: - At least one team member must review and approve - Do not merge your own PRs without approval - Reviews should be thorough, address all feedback - Await successful CI/CD pipeline completion

PR Review Checklist

Before requesting a review, ensure:

  • All tests pass.
  • Code is formatted and linted.
  • Documentation is updated (if needed).
  • PR description is clear and complete.
  • Linked to a Linear ticket (if applicable)

See Code Reviews for detailed review guidelines.

Observability and Debugging

Sentry

Purpose: Error tracking and performance monitoring. Access the Sentry Issues Dashboard to view production errors and performance issues.

Sentry provides: - Real-time error tracking with full stack traces - Performance monitoring and transaction tracking - Error context (user data, request details, environment) - Linear integration for creating tickets from errors

Usage: 1. Check Sentry dashboard for error reports 2. Review error context, stack traces, and affected users 3. Create Linear tickets for critical issues (e.g., ORB-215) 4. Use Sentry's breadcrumbs and context to understand error flow 5. Link Sentry issues to Linear tickets for tracking

Best Practices: - Monitor Sentry regularly for new errors - Set up alerts for critical error types - Include relevant context in error logs - Use structured logging for better Sentry context - Create Linear tickets for bugs found in Sentry

Development Tools

Cursor and Bugbot

Purpose: AI-powered development assistance: - Cursor: AI-powered code editor - Bugbot: AI assistant integrated into workflow

Key Features: - Code Generation: Generate code based on natural language descriptions. - Code Completion: Intelligent autocomplete and suggestions. - Code Review: AI-assisted code review and suggestions. - Documentation: Generate and update documentation. - Bug Fixing: Help identify and fix bugs.

Best Practices: - Use Cursor for rapid prototyping and boilerplate code generation - Leverage Bugbot for debugging and understanding the codebase - Review AI-generated code carefully before committing - Use Cursor's context awareness to work with our codebase patterns - Combine AI assistance with manual review for critical changes

Resources: - Cursor Documentation: Official Cursor IDE documentation and tutorials - Use Cursor's @ mentions to reference files, folders, and code - Use Cursor's chat for asking questions about the codebase - Leverage Cursor's codebase indexing for better context

Integration with Our Workflow: - Cursor understands our repository structure and patterns - Use Cursor to generate code following our established patterns (Repository, Service Layer, etc.) - Bugbot can help debug issues found in Sentry - Link Cursor-generated code to Linear tickets when appropriate

Getting Help

  • Slack: Post in #engineer-bug-requests for questions or issues
  • Linear: Create ticket for bugs or feature requests
  • Sentry: Check production errors and create tickets for critical issues
  • Team Drive: Check shared documents for design decisions
  • Wiki: Review architecture and best practices documentation
  • Cursor/Bugbot: Use AI assistance for development tasks