Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (25 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

37 lines (25 loc) · 1.01 KB
Raw

Contributing

Thanks for your interest in contributing to second-opinion-mcp-server!

Development Setup

  1. Fork and clone the repo
  2. Install dependencies: npm install
  3. Build: npm run build
  4. Run tests: npm test

Requires Node.js 24+. Use nvm install to pick up the version from .nvmrc.

Making Changes

  1. Create a branch from main
  2. Make your changes
  3. Add or update tests as needed
  4. Ensure npm run build and npm test pass
  5. Update docs/changelog/CHANGELOG.md for user-visible changes
  6. Open a pull request

Integration tests in providers.integration.test.ts require OPENROUTER_API_KEY in the environment (or a .env file); they are skipped when the key is absent.

Reporting Issues

Use GitHub Issues to report bugs or request features. Include:

  • Steps to reproduce (for bugs)
  • Expected vs actual behavior
  • Node.js version and OS

Code Style

  • TypeScript strict mode
  • ESM modules (.js extensions in imports)
  • Keep it simple