Skip to content

Commit 94d074e

Browse files
committed
Add CHANGELOG, LICENSE, CONTRIBUTING guide
1 parent 8465ab0 commit 94d074e

3 files changed

Lines changed: 117 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Changelog
2+
3+
All notable changes to Vibe Stack will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/).
6+
7+
## [1.0.0] - 2026-03-30
8+
9+
### Added
10+
- **20 `.mdc` Architecture Rules** — Battle-tested constraints for AI-assisted development
11+
- `supabase-auth-security.mdc` — Bans getSession(), enforces getUser()
12+
- `nextjs15-params.mdc` — Prevents synchronous params (Next.js 15 breaking change)
13+
- `supabase-ssr-only.mdc` — Blocks deprecated auth-helpers-nextjs
14+
- `security.mdc` — OWASP Top 10 enforcement
15+
- `stripe-payments.mdc` — Server-only Stripe integration
16+
- `typescript-strict.mdc` — Bans `any`, enforces Zod
17+
- `performance.mdc` — Parallel fetching, N+1 prevention
18+
- `server-vs-client-components.mdc` — Prevents 'use client' overuse
19+
- `project-context.mdc` — Global architecture context
20+
- `server-actions.mdc` — Zod validation + ActionResponse
21+
- `error-handling.mdc` — Error boundaries
22+
- `supabase-rls.mdc` — Row Level Security enforcement
23+
- `shadcn-patterns.mdc` — Form patterns
24+
- `api-design.mdc` — Route Handler standards
25+
- `testing.mdc` — Vitest + Playwright
26+
- `git-conventions.mdc` — Conventional commits
27+
- `ai-collaboration.mdc` — 3-stage agentic loop
28+
- `file-naming.mdc` — Naming conventions + import order
29+
- `database-design.mdc` — Schema patterns + RLS templates
30+
- `env-management.mdc` — Secret classification
31+
32+
- **4 MCP Server Integrations** — GitHub, Filesystem, Supabase, Browser
33+
- **Complete Auth System** — Login, signup, email verification (PKCE), protected dashboard
34+
- **Stripe Integration** — Webhook handler, checkout, customer portal
35+
- **Resend Email** — Welcome + password reset templates
36+
- **3 n8n Workflows** — GitHub star leads, Dev.to cross-post, Gumroad CRM
37+
- **Documentation** — VIBE-CODING.md, ARCHITECTURE.md, MCP-SETUP.md
38+
- **Error Handling** — Global error boundary, loading state, custom 404
39+
- **Type Safety** — ActionResponse<T>, UserProfile, type-safe env config

CONTRIBUTING.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Contributing to Vibe Stack
2+
3+
Thanks for your interest in contributing! This project thrives on community-reported hallucination patterns.
4+
5+
## How to Contribute
6+
7+
### Report a Hallucination Pattern
8+
9+
If you've found a pattern that AI models consistently get wrong:
10+
11+
1. **Open an issue** with the title: `[Rule Request] Description of the pattern`
12+
2. Include:
13+
- **The wrong code** the AI generates
14+
- **The correct code** it should generate
15+
- **Why it's wrong** (security flaw, deprecated API, performance issue)
16+
- **Which models** you've tested it with (Claude, GPT-4, Gemini)
17+
18+
### Submit a New Rule
19+
20+
If you've already written a `.mdc` rule:
21+
22+
1. Fork the repo
23+
2. Add your rule to `.cursor/rules/`
24+
3. Ensure it follows the format:
25+
```markdown
26+
---
27+
description: Brief description of what this rule prevents
28+
globs: ["**/relevant/path/**"]
29+
alwaysApply: false
30+
---
31+
32+
# Rule Title
33+
34+
CLEAR INSTRUCTION about what to do and not do.
35+
36+
✅ CORRECT: example code
37+
❌ WRONG: example code that AI typically generates
38+
```
39+
4. Open a PR with a description of what pattern this prevents
40+
41+
### Improve Documentation
42+
43+
Found a typo? Want to improve an explanation? PRs for documentation are always welcome.
44+
45+
## Development Setup
46+
47+
```bash
48+
git clone https://github.com/vibestackdev/vibe-stack.git
49+
cd vibe-stack
50+
npm install
51+
cp .env.example .env.local
52+
npm run dev
53+
```
54+
55+
## Code of Conduct
56+
57+
Be helpful. Be respectful. We're all here to ship better software with AI.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 VibeStack
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)