Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

71 lines (49 loc) · 2.01 KB

Contributing to RequestTap Router

Thank you for your interest in contributing to RequestTap Router! This guide will help you get started.

Reporting Bugs

Open an issue on GitHub Issues with:

  • A clear, descriptive title
  • Steps to reproduce the bug
  • Expected vs actual behavior
  • Node.js version, OS, and any relevant environment details
  • Relevant log output or error messages

Suggesting Features

Open a GitHub Issue with the feature label. Describe:

  • The problem your feature would solve
  • Your proposed solution
  • Any alternatives you've considered

Development Setup

# Clone the repo
git clone https://github.com/RequestTap/RequestTap-Router.git
cd RequestTap-Router

# Install dependencies
npm install

# Build all workspaces
npm run build

# Run tests
npm test

See the README for full setup instructions including environment variables and route configuration.

Pull Request Process

  1. Fork the repository and create a branch from main
  2. Make your changes — keep PRs focused on a single concern
  3. Write tests for new functionality
  4. Run the full test suite — npm test
  5. Open a PR against main with a clear description of the change

Code Style

  • ESM (import/export) throughout — no CommonJS
  • TypeScript with NodeNext module resolution
  • Follow existing patterns in the codebase
  • Use .js extensions in import paths (required by NodeNext)

Project Structure

This is an npm workspaces monorepo. See the README for a breakdown of each package.

Workspace Purpose
packages/shared Types, schemas, constants
packages/gateway Express HTTP gateway
packages/sdk Agent client SDK
dashboard Admin dashboard
examples/agent-demo Demo script

Questions?

Open an issue or email support@requesttap.ai.