Skip to content

jackhai9/vibe-coding-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vibe Coding Guide

简体中文 | English

This repository collects practical workflow notes for working with AI coding agents. The focus is not prompt tricks. It is a repeatable engineering process: clarify the idea, write constraints, plan the work, implement with evidence, and keep rules reusable across projects.

What This Guide Covers

  • How to turn a rough project idea into a clearer implementation brief.
  • How to use rule files such as AGENTS.md or CLAUDE.md without making them vague.
  • How to define hard constraints that AI agents are more likely to follow.
  • How to structure long-running implementation work with plans.
  • How to keep reusable rules under rules/.

Repository Layout

  • README.zh-CN.md is the full Chinese guide.
  • rules/README.md explains the rule files.
  • rules/spec_driven_rules.md records spec-driven development rules.
  • rules/my_own_rules.md records personal engineering rules.
  • rules/fractal_doc_rules.md describes the dynamic documentation structure.
  • rules/plans.md describes execution plans for long-running work.

Recommended Use

  1. Start with the Chinese guide in README.zh-CN.md.
  2. Copy only the rule files that match the target project.
  3. Keep rules strict and executable: prefer MUST, DO, DO NOT, and concrete validation.
  4. Update the rule files when a repeated workflow becomes stable.

License

The guide and rule documents are licensed under Creative Commons Attribution 4.0 International. See LICENSE.

Releases

No releases published

Packages

 
 
 

Contributors