Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (47 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

67 lines (47 loc) · 1.96 KB
Raw

Contributing to Knowledge Assistant

Thank you for your interest in contributing to the Knowledge Assistant project!

Project Overview

This is a demonstration project built for the Cloudflare AI assignment. It showcases the full capabilities of Cloudflare's AI agent platform.

Development Setup

  1. Fork and clone the repository
  2. Install dependencies: 
    npm install
cd backend && npm install
cd ../frontend && npm install
  3. Set up Cloudflare services (see README.md)
  4. Run locally:
    • Backend: cd backend && npm run dev
    • Frontend: cd frontend && npm run dev

Code Structure

  • backend/src/agent.ts - Core agent logic with Durable Objects
  • backend/src/workflows.ts - Background processing workflows
  • backend/src/index.ts - Worker entry point and routing
  • frontend/src/ - React application with components and hooks

Coding Standards

  • TypeScript: All code is TypeScript with strict mode enabled
  • Formatting: Use consistent indentation (2 spaces)
  • Comments: Add comments for complex logic
  • Types: Define proper interfaces in types.ts

Testing

Before submitting changes:

  1. Test locally with both backend and frontend
  2. Verify WebSocket connections work
  3. Test voice input functionality
  4. Check responsive design on mobile

Pull Request Process

  1. Create a feature branch from main
  2. Make your changes with clear commit messages
  3. Test thoroughly
  4. Update documentation if needed
  5. Submit a pull request with description of changes

AI-Assisted Development

This project encourages AI-assisted development! If you use AI tools:

  • Document significant prompts in PROMPTS.md
  • Ensure code quality and understanding
  • Test thoroughly

Questions?

Feel free to open an issue for discussion or questions about the project.

Note: This is a demonstration project for educational purposes. All contributions should maintain the original spirit of showcasing Cloudflare's AI platform capabilities.