Emmett

Appearance

Contributing to Emmett ​

WARNING

We created this page with the help of the GenAI tool.

We're currently double-checking it to ensure the information is 100% correct and free of hallucinations.

We welcome contributions! This guide covers everything you need to get started.

Ways to Contribute ​

TypeDescription
🐛 Bug ReportsFound something broken? Open an issue
💡 Feature RequestsHave an idea? Start a discussion
📖 DocumentationImprove guides, fix typos, add examples
🧪 TestsIncrease coverage, add edge cases
💻 CodeFix bugs, implement features

Getting Started ​

Prerequisites ​

  • Node.js 22+
  • npm 11+
  • Docker (for integration tests)

Setup ​

bash
# Clone the repository
git clone https://github.com/event-driven-io/emmett.git
cd emmett

# Install dependencies
npm install

# Build all packages
npm run build

# Run tests
npm run test

Project Structure ​

src/
├── packages/
│   ├── emmett/              # Core package
│   ├── emmett-postgresql/   # PostgreSQL event store
│   ├── emmett-esdb/         # EventStoreDB adapter
│   ├── emmett-mongodb/      # MongoDB event store
│   ├── emmett-sqlite/       # SQLite event store
│   ├── emmett-expressjs/    # Express.js integration
│   ├── emmett-fastify/      # Fastify integration
│   ├── emmett-testcontainers/  # Test utilities
│   └── emmett-shims/        # Polyfills
├── docs/                    # Documentation (VitePress)
└── samples/                 # Sample applications

Development Workflow ​

Running Tests ​

bash
# All tests
npm run test

# Specific package
npm -ws @event-driven-io/emmett run test

# Watch mode
npm --ws @event-driven-io/emmett run test:watch

# With coverage
npm run test:coverage

Building ​

bash
# All packages
npm run build

# Specific package
npm --ws @event-driven-io/emmett run build

# Watch mode (development)
npm --ws @event-driven-io/emmett run build:watch

Linting and Formatting ​

bash
# Check linting
npm run lint

# Fix linting issues
npm run lint:fix

# Format code
npm run format

Making Changes ​

1. Create a Branch ​

bash
git checkout -b feature/your-feature-name
# or
git checkout -b fix/issue-description

2. Make Your Changes ​

  • Follow existing code style
  • Add tests for new functionality
  • Update documentation if needed

3. Test Your Changes ​

bash
# Run tests for affected packages
npm run test

# Run full build
npm run build

4. Commit Your Changes ​

Remember to make your commit message meaningful and group changes into commits logically.

5. Open a Pull Request ​

  • Fill out the PR template
  • Link related issues
  • Wait for CI to pass
  • Address review feedback

Code Style ​

TypeScript Guidelines ​

typescript
// ✅ Good: Use explicit types for exports
export type ShoppingCartEvent =
  | Event<'ProductItemAdded', { productId: string; quantity: number }>
  | Event<'ShoppingCartConfirmed', { confirmedAt: Date }>;

// ✅ Good: Use readonly for immutable data
interface ShoppingCart {
  readonly id: string;
  readonly items: readonly ProductItem[];
}

// ✅ Good: Prefer const assertions
const STATUSES = ['Pending', 'Confirmed', 'Cancelled'] as const;

// ✅ Good: Use discriminated unions
type Result<T> = { success: true; value: T } | { success: false; error: Error };

Testing Guidelines ​

typescript
// ✅ Good: Use BDD-style specifications
describe('Shopping Cart', () => {
  it('adds product to empty cart', () =>
    spec([]).when(addProductCommand).then([productAddedEvent]));
});

// ✅ Good: Test edge cases
it('rejects negative quantity', () =>
  spec([])
    .when({ type: 'AddProduct', data: { quantity: -1 } })
    .thenThrows(ValidationError));

Adding a New Package ​

  1. Create package directory under src/packages/
  2. Add package.json with proper naming
  3. Add to workspace in root npm-workspace.yaml
  4. Create README following package README template
  5. Add to documentation

Documentation ​

Running Docs Locally ​

bash
cd src/docs
npm install
npm run dev

Writing Documentation ​

  • Use VitePress markdown features
  • Include working code examples
  • Follow the Diataxis framework:
    • Tutorials: Learning-oriented (Getting Started)
    • How-to Guides: Task-oriented (Guides)
    • Reference: Information-oriented (API Reference)
    • Explanation: Understanding-oriented (deep dives)

Issue Guidelines ​

Bug Reports ​

Include:

  • Emmett version
  • Node.js version
  • Minimal reproduction
  • Expected vs actual behavior
  • Error messages/stack traces

Feature Requests ​

Include:

  • Use case description
  • Proposed API (if applicable)
  • Alternatives considered

Getting Help ​

Recognition ​

Contributors are recognized in:

  • Release notes
  • README contributors section
  • GitHub contributors page

Code of Conduct ​

We follow the Contributor Covenant. Be respectful, inclusive, and constructive.

License ​

By contributing, you agree that your contributions will be licensed under the MIT License.

See Also ​

Copyright © Oskar Dudycz and contributors.