Contributing

Contributing

Thank you for your interest in contributing!

Getting Started

1. Fork the repository
2. Clone your fork:

   git clone https://github.com/YOUR_USERNAME/fedramp-docs-mcp.git

3. Install dependencies:

   npm install
   npm run build

Development Workflow

Create a Branch

git checkout -b feature/your-feature

Make Changes

npm run dev   # Development mode
npm test      # Run tests
npm run lint  # Check code style

Test with MCP Inspector

npx @modelcontextprotocol/inspector node dist/index.js

Commit

Follow Conventional Commits:

• feat: - New feature
• fix: - Bug fix
• docs: - Documentation
• test: - Tests
• refactor: - Refactoring

Submit PR

Push and open a Pull Request with:

• Clear description
• Reference to issues
• Test results

Ways to Contribute

• Report bugs - Open an issue
• Suggest features - Open an issue
• Improve docs - Submit a PR
• Submit code - Fork, branch, PR

Code Style

• TypeScript strict mode
• ESLint + Prettier
• Meaningful variable names
• Tests for new functionality

Resources

• Local Development Guide
• GitHub Repository
• Issues