Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
123 lines (91 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

123 lines (91 loc) · 2.52 KB

Contributing to Second Brain MCP

Thank you for your interest in contributing! Here's how to get started.

🛠️ Development Setup

  1. Clone the repository

    git clone https://github.com/codebyellalesperance/Second-Brain-MCP.git
cd Second-Brain-MCP

  2. Install dependencies

    yarn install

  3. Set up environment

    cp env.example .env
# Add your API keys to .env

  4. Build the project

    yarn build

  5. Run tests

    yarn test

🧪 Testing

  • Run all tests: yarn test
  • Watch mode: yarn test:watch
  • Coverage: yarn test:coverage
  • Interactive UI: yarn test:ui

All tests must pass before submitting a PR. The CI will automatically run tests on Node.js 18 and 20.

📝 Pull Request Process

  1. Create a branch for your feature/fix

    git checkout -b feature/your-feature-name

  2. Make your changes and write tests

  3. Ensure tests pass

    yarn test
yarn build

  4. Commit your changes

    git add .
git commit -m "feat: add new feature"

  5. Push to your fork

    git push origin feature/your-feature-name

  6. Create a Pull Request on GitHub

📋 Code Style

  • Use TypeScript strict mode
  • Follow existing code patterns
  • Add tests for new features
  • Update documentation as needed

🐛 Reporting Issues

When reporting issues, please include:

  • Description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • System information (OS, Node version)
  • Error messages/logs

✅ Continuous Integration

Our CI pipeline runs on every push and PR:

  • Tests: All 60+ tests across 4 test suites
  • Type checking: TypeScript compilation
  • Node versions: Tested on 18.x and 20.x

📦 Project Structure

second-brain-mcp/
├── src/
│   ├── ingest/         # Input methods (CLI, voice)
│   ├── server/         # MCP server
│   ├── api/            # REST API
│   ├── storage/        # Data persistence
│   └── utils/          # Shared utilities
├── tests/              # Test files
├── .github/            # GitHub Actions workflows
└── dist/               # Build output

🔒 Security

  • Never commit .env files
  • Keep API keys secret
  • Review encryption changes carefully
  • Report security issues privately

💬 Questions?

Feel free to open an issue for discussion or clarification!

Happy coding! 🚀