Skip to content

feat: Initialize GitHub Spec Kit with spec directory structurefeat: Initialize GitHub Spec Kit with spec directory structurefeat: Initialize GitHub Spec Kit with spec directory structurefeat: I… #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chaithanyachaganti27-svg wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Initialize GitHub Spec Kit with spec directory structurefeat: Initialize GitHub Spec Kit with spec directory structurefeat: Initialize GitHub Spec Kit with spec directory structurefeat: I… #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions spec/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Spec-Driven Development for Free Cluely

This directory contains the specification files for implementing Spec-Driven Development using GitHub Spec Kit in the Free Cluely project.

## Overview

Free Cluely is an undetectable desktop application that helps users with exam assistance. This spec-driven approach helps structure development around clear specifications and requirements.

## Directory Structure

```
spec/
├── README.md # This file - overview of spec setup
├── specification.md # Main application specification
├── plan.md # Technical implementation plan
├── tasks.md # Actionable task breakdown
└── memory/ # Context and background information
└── context.md # Project context and constraints
```

## Spec-Driven Development Process

### 1. Specify (/specify)
Define what you want to build, focusing on the "what" and "why" rather than technical details.

### 2. Plan (/plan)
Create a technical implementation plan with architecture and tech stack choices.

### 3. Break Down (/tasks)
Generate actionable tasks that can be implemented step by step.

### 4. Implement
Use the tasks and specifications to guide development with AI coding agents.

## Usage with AI Coding Agents

This spec structure is designed to work with:
- Claude Code
- GitHub Copilot
- Gemini CLI
- Other AI coding assistants

## Getting Started

1. Review the specification files in this directory
2. Use the `/specify`, `/plan`, and `/tasks` commands with your AI coding agent
3. Reference these files during development to maintain consistency
4. Update specifications as the project evolves

## Benefits

- **Intent-driven development**: Focus on user needs and business logic first
- **Better collaboration**: Clear specifications help team understanding
- **Iterative improvement**: Structured approach to feature development
- **AI-friendly**: Optimized for working with coding assistants

## Related Resources

- [GitHub Spec Kit](https://github.com/github/spec-kit)
- [Spec-Driven Development Guide](https://github.com/github/spec-kit/blob/main/spec-driven.md)
- [Free Cluely Main Repository](https://github.com/Prat011/free-cluely)