Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

66 lines (49 loc) · 1.63 KB

Contributing to Gemini Code Flow

We welcome contributions to Gemini Code Flow! This project is adapted from Claude Code Flow by ruvnet, and we maintain the same collaborative spirit.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/gemini-code-flow.git
  3. Install dependencies: npm install
  4. Build the project: npm run build

Development

Prerequisites

  • Node.js 18+
  • TypeScript knowledge
  • Gemini API key for testing

Project Structure

src/
├── core/           # Core orchestration logic
├── commands/       # CLI commands
├── types/          # TypeScript interfaces
└── utils/          # Utility functions

Testing

npm test

Code Style

  • Use TypeScript strict mode
  • Follow existing code patterns
  • Add JSDoc comments for public APIs
  • Include attribution comments where adapting from Claude Code Flow

Submitting Changes

  1. Create a feature branch: git checkout -b feature/your-feature
  2. Make your changes
  3. Add tests if applicable
  4. Update documentation
  5. Commit with clear messages
  6. Push and create a pull request

Attribution

When contributing, please:

  • Maintain attribution to ruvnet's original Claude Code Flow
  • Document any significant adaptations or new features
  • Follow the same architectural patterns where possible

Code of Conduct

  • Be respectful and inclusive
  • Focus on constructive feedback
  • Credit original work appropriately
  • Help maintain the open-source spirit

Questions?

Open an issue or start a discussion. We're here to help!

Thank you for contributing to Gemini Code Flow! 🚀