Skip to content

contributing.md

Latest commit

 

History

History
161 lines (125 loc) · 4.73 KB

contributing.md

File metadata and controls

161 lines (125 loc) · 4.73 KB
title Contributing
description How to contribute to the Sentry CLI

We welcome contributions to the Sentry CLI! This guide will help you get started.

Development Setup

Prerequisites

  • Git

Getting Started

# Clone the repository
git clone https://github.com/getsentry/cli.git
cd cli

# Install dependencies
pnpm install

# Run CLI in development mode
pnpm run cli -- --help

# Run tests
pnpm run test

Environment Variables

Create a .env.local file for development:

cp .env.example .env.local

Edit .env.local with your development credentials.

Project Structure

cli/
├── src/
│   ├── bin.ts          # Entry point
│   ├── app.ts          # Stricli application setup
│   ├── context.ts      # Dependency injection context
│   ├── commands/       # CLI commands
│   │   ├── alert/       # create, delete, edit, list, view
│   │   ├── auth/        # login, logout, refresh, status, token, whoami
│   │   ├── cli/         # defaults, feedback, fix, import, setup, uninstall, upgrade
│   │   ├── code-mappings/# upload
│   │   ├── dart-symbol-map/# upload
│   │   ├── dashboard/   # add, create, delete, edit, list, restore, revisions, view
│   │   ├── debug-files/ # bundle-jvm, bundle-sources, check, print-sources, upload
│   │   ├── event/       # list, send, view
│   │   ├── issue/       # archive, events, explain, list, merge, plan, resolve, unresolve, view
│   │   ├── local/       # run, serve
│   │   ├── log/         # list, view
│   │   ├── monitor/     # list, run
│   │   ├── org/         # list, view
│   │   ├── proguard/    # upload, uuid
│   │   ├── project/     # create, delete, list, view
│   │   ├── release/     # archive, create, delete, deploy, deploys, finalize, list, propose-version, restore, set-commits, view
│   │   ├── replay/      # list, view
│   │   ├── repo/        # list
│   │   ├── sourcemap/   # inject, resolve, upload
│   │   ├── span/        # list, view
│   │   ├── team/        # list
│   │   ├── trace/       # list, logs, view
│   │   ├── trial/       # list, start
│   │   ├── api.ts       # Make an authenticated API request
│   │   ├── explore.ts   # Query aggregate event data (Explore)
│   │   ├── help.ts      # Help command
│   │   ├── init.ts      # Initialize Sentry in your project (experimental)
│   │   └── schema.ts    # Browse the Sentry API schema
│   ├── lib/            # Shared utilities
│   └── types/          # TypeScript types and Zod schemas
├── test/               # Test files (mirrors src/ structure)
├── script/             # Build and utility scripts
├── plugins/            # Agent skill files
└── docs/               # Documentation site (Astro + Starlight)

Building

# Build for current platform (uses esbuild + fossilize for Node SEA packaging)
pnpm run build

# Build for all platforms
pnpm run build:all

# Create npm bundle
pnpm run bundle

Testing

# Run all tests
pnpm run test

# Run specific test file
pnpm run test -- test/path/to/test.ts

# Run with watch mode
pnpm run test -- --watch

# Run with coverage
pnpm run test -- --coverage

Code Style

The project uses Ultracite for linting and formatting:

# Check for issues
pnpm run lint

# Auto-fix issues
pnpm run lint:fix

# Type checking
pnpm run typecheck

Submitting Changes

  1. Fork the repository
  2. Create a feature branch: git checkout -b feat/my-feature
  3. Make your changes
  4. Run tests and linting: pnpm run test && pnpm run lint
  5. Commit with conventional commits: git commit -m "feat: add new feature"
  6. Push and create a pull request

Conventional Commits

We use conventional commits for automatic changelog generation:

  • feat: - New features
  • fix: - Bug fixes
  • docs: - Documentation changes
  • refactor: - Code refactoring
  • test: - Test changes
  • chore: - Maintenance tasks

Getting Help