Skip to content

Contributing

This guide provides information for developers who want to contribute to the 1Password MCP Server.

Getting Started

Prerequisites

  • Python 3.8 or higher
  • 1Password CLI installed and configured
  • Git for version control

Development Environment Setup

  1. Clone the repository
  2. Set up virtual environment
  3. Install development dependencies
  4. Configure pre-commit hooks

Development Workflow

Code Standards

  • Follow PEP 8 style guidelines
  • Use type hints for all functions
  • Write comprehensive tests
  • Include docstrings for all public APIs

Security Considerations

  • Never commit credentials or sensitive data
  • Follow secure coding practices
  • Implement proper input validation
  • Use security linting tools

Testing

  • Write unit tests for all new functionality
  • Include integration tests for API endpoints
  • Test error handling scenarios
  • Maintain high test coverage

Pull Request Process

  1. Create feature branch from main
  2. Implement changes with tests
  3. Update documentation
  4. Submit pull request with detailed description

Documentation Status

This documentation is currently under development. Detailed contribution guidelines will be added.