Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cline Template Repository

A template repository designed to help you work effectively with AI assistants like Cline.

Purpose

This repository provides a structured framework for communicating project context, requirements, and progress to AI assistants. By maintaining well-organized documentation in the memory_bank directory, you can help AI assistants understand your project more deeply and provide more relevant assistance.

Features

  • Memory Bank: A collection of markdown files that provide context about your project
  • .clinerules: Configuration file that helps AI assistants understand your project structure and workflow
  • Template Structure: Ready-to-use templates for common project documentation needs

Getting Started

  1. Click "Use this template" to create a new repository based on this template
  2. Clone your new repository to your local machine
  3. Customize the files in the memory_bank directory with your project details
  4. Update the .clinerules file with your project's specific configuration
  5. See GETTING_STARTED.md for more detailed instructions

Memory Bank Structure

The memory_bank directory contains several markdown files that help provide context to AI assistants:

  • project_brief.md: High-level overview of your project, its goals, and requirements
  • tech_context.md: Technical details about your project's stack, architecture, and environment
  • product_context.md: Information about your product vision, user personas, and feature priorities
  • system_patterns.md: Details about your system's architecture, design patterns, and data flow
  • active_context.md: Current development focus, recent changes, and known issues
  • progress.md: Tracking of implemented features and upcoming work

Best Practices

  • Keep the memory bank files updated as your project evolves
  • Be specific about your project's technical requirements and constraints
  • Clearly communicate your development workflow and preferences
  • Update the active context before each AI assistant session

Contributing

Feel free to suggest improvements to this template by opening an issue or pull request.

License

MIT License

About

Template for a code repository that leverages the cline extension for vscode as an AI code assist.

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors