Contributing to Deep Research

Thank you for your interest in contributing to Deep Research! We welcome contributions from everyone who shares our commitment to privacy-focused AI research.

Getting Started

1. Fork the repository
2. Clone your fork: git clone https://github.com/your-username/deep-research-privacy.git
3. Create a new branch: git checkout -b feature/your-feature-name
4. Make your changes
5. Push to your fork: git push origin feature/your-feature-name
6. Open a Pull Request

Development Setup

1. Install dependencies: npm install
2. Copy example config: cp .env.example .env
3. Add your API keys to .env
4. Start development server: npm run dev

Code Style

• Use TypeScript for all new code
• Follow existing patterns in the codebase
• Include comprehensive comments
• Write tests for new features
• Ensure all tests pass: npm test

Commit Messages

Please follow these guidelines for commit messages:

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally after the first line

Pull Request Process

1. Update the README.md with details of changes to the interface
2. Update the documentation if you're adding or modifying features
3. Add tests for new functionality
4. Ensure the test suite passes
5. Update the version numbers in package.json and README.md following SemVer

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to george.g.larson@gmail.com.

Questions?

If you have any questions, please feel free to:

• Open an issue
• Start a discussion
• Contact the maintainer directly