Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
106 lines (74 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

106 lines (74 loc) · 3.19 KB

Contributing to Outlook Assistant Server

Thank you for your interest in contributing! This document provides guidelines and instructions.

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

How to Contribute

Reporting Bugs

Before creating a bug report, please check existing issues to avoid duplicates.

When creating a bug report, include:

  • Node.js version (node --version)
  • Operating system
  • Steps to reproduce
  • Expected vs actual behaviour
  • Relevant error messages or logs

Use the bug report template when opening an issue.

Suggesting Features

Feature requests are welcome! Use the feature request template and include:

  • Clear description of the feature
  • Use case / problem it solves
  • Proposed implementation (if any)
  • Alternatives considered

Pull Requests

  1. Fork the repository and create your branch from main
  2. Install dependencies: npm install
  3. Make your changes following the code style below
  4. Add tests for new functionality
  5. Run tests: npm test
  6. Run linting: npm run lint
  7. Update documentation if needed
  8. Submit a pull request using the PR template

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/outlook-assistant.git
cd outlook-assistant

# Install dependencies
npm install

# Run tests
npm test

# Start in test mode (no real API calls)
npm run test-mode

# Interactive testing with MCP Inspector
npm run inspect

Code Style

  • Use consistent indentation (2 spaces)
  • Use meaningful variable and function names
  • Add JSDoc comments for public functions
  • Keep functions focused and small
  • Handle errors appropriately

Project Structure

When adding new tools:

  1. Create a new module directory if needed (e.g. tasks/)
  2. Implement tool handlers in separate files
  3. Export tool definitions from the module's index.js — prefer consolidating related operations into a single tool with an action parameter (STRAP pattern)
  4. Include an annotations object on each tool definition (readOnlyHint, destructiveHint, idempotentHint) — see the Tools Reference for examples
  5. Add tools to the TOOLS array in main index.js
  6. Add tests in the test/ directory
  7. Update docs/quickrefs/tools-reference.md

Commit Messages

Follow Conventional Commits:

feat: add conversation export to MBOX format
fix: resolve folder stats API error
docs: update installation instructions
test: add tests for contacts module

Testing

  • Write tests for new functionality
  • Ensure existing tests pass: npm test
  • Use test mode for development: USE_TEST_MODE=true npm start

Questions?

If you have questions, feel free to open a discussion.

License

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