Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (35 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

48 lines (35 loc) · 1.59 KB

Contributing to worker-observability

Thank you for your interest in contributing. This project is maintained by Stackbilt.

Getting Started

  1. Fork the repository
  2. Clone your fork
  3. Install dependencies: npm install
  4. Run the type checker: npm run typecheck

Development

This package targets Cloudflare Workers. All code must be compatible with the Workers runtime (no Node.js-only APIs).

Project Structure

src/
  types.ts          Type definitions
  health.ts         Health checks and aggregation
  logger.ts         Structured JSON logging
  metrics.ts        Metrics collection and export
  tracing.ts        Distributed tracing (W3C Trace Context)
  errors.ts         Error tracking, circuit breaker, retry
  dashboard.ts      Dashboard aggregation and HTML generation
  sli-monitor.ts    SLI/SLO monitoring
  alert-manager.ts  Alert rules and incident management
  index.ts          Public API exports

Guidelines

  • Zero production dependencies is the goal. Avoid adding runtime dependencies.
  • All Cloudflare-specific types come from @cloudflare/workers-types (dev dependency).
  • Keep modules independent. Each file should work standalone with only ./types as a shared dependency.
  • Maintain backward compatibility. Breaking changes require a major version bump.

Submitting Changes

  1. Create a branch from main
  2. Make your changes
  3. Ensure npm run typecheck passes
  4. Open a pull request with a clear description of what changed and why

License

By contributing, you agree that your contributions will be licensed under the Apache-2.0 license.