Skip to content

Commit 126baad

Browse files
authored
Publish public vibecoding playbook structure (#1)
1 parent 7c4acc1 commit 126baad

34 files changed

Lines changed: 1247 additions & 453 deletions
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Bug report
3+
about: Report a broken link, wrong instruction, or inaccurate workflow guidance
4+
title: "[Bug] "
5+
labels: [bug]
6+
assignees: []
7+
---
8+
9+
## What is wrong?
10+
11+
## Where did you see it?
12+
13+
## Why does it matter?
14+
15+
## Suggested correction
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Documentation improvement
3+
about: Suggest a clearer explanation, better structure, or stronger onboarding
4+
title: "[Docs] "
5+
labels: [documentation]
6+
assignees: []
7+
---
8+
9+
## What part of the docs needs improvement?
10+
11+
## What is confusing or missing?
12+
13+
## What would make it clearer?
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Experience report
3+
about: Share how you adapted or used this playbook in practice
4+
title: "[Experience] "
5+
labels: [experience-report]
6+
assignees: []
7+
---
8+
9+
## Context
10+
11+
## Which parts of the playbook did you use?
12+
13+
## What worked well?
14+
15+
## What broke or felt confusing?
16+
17+
## What should the repository document better?

.github/pull_request_template.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Summary
2+
3+
-
4+
5+
## Why this improves the playbook
6+
7+
-
8+
9+
## Docs or structure affected
10+
11+
- [ ] README
12+
- [ ] foundations docs
13+
- [ ] OpenCode implementation docs
14+
- [ ] templates or examples
15+
- [ ] contributor/community files
16+
17+
## Verification
18+
19+
- [ ] links and file paths checked
20+
- [ ] English and Chinese coverage considered
21+
- [ ] no duplicate workflow authority introduced

CHANGELOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,22 @@ All notable workflow and documentation changes for this repository should be rec
1818
- improved README positioning, navigation, and adoption guidance
1919
- clarified private-first status and future open-source direction
2020

21+
## 2026-03-28
22+
23+
### Added
24+
25+
- public-facing foundations docs for vibecoding principles, anti-patterns, verification, and case studies
26+
- new `docs/opencode/` implementation layer and decision record structure
27+
- Simplified Chinese foundations and OpenCode implementation docs
28+
- `LICENSE`, `SECURITY.md`, `ROADMAP.md`, and GitHub issue/PR templates
29+
- richer workflow-oriented prompt examples for English and Chinese readers
30+
31+
### Changed
32+
33+
- rewrote both README entry points around a dual-path public playbook structure
34+
- removed private-draft packaging from the repository landing experience
35+
- updated contribution guidance for public open-source collaboration
36+
2137
## 2026-03-22
2238

2339
### Documented

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22

33
Thanks for your interest in improving this repository.
44

5-
This project is currently **private-first** but intentionally structured for a future public open-source release. Contributions should preserve that direction: clarity first, composability second, novelty last.
5+
This project is a public playbook for AI-assisted development workflows. Contributions should preserve that direction: clarity first, composability second, novelty last.
66

77
## What this repository values
88

99
- clear ownership boundaries
1010
- durable documentation over prompt clutter
1111
- reusable templates over private environment assumptions
1212
- bilingual parity where practical
13+
- evidence-backed guidance over workflow hype
1314

1415
## Contribution principles
1516

@@ -39,7 +40,6 @@ When contributing to this repo, prefer changes that make the workflow:
3940
## What is not in scope yet
4041

4142
- screenshots or heavy visual assets without a stable story
42-
- public governance decisions that depend on future open-sourcing timing
4343
- speculative integrations that are not used in the documented stack
4444

4545
## Pull request expectations
@@ -50,6 +50,7 @@ Good pull requests for this repo usually:
5050
- keep documentation structure clean
5151
- avoid introducing duplicate workflow authority
5252
- preserve or improve bilingual parity
53+
- distinguish clearly between transferable methodology and OpenCode-specific implementation
5354

5455
## Questions to ask before opening a PR
5556

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 XenoExia
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)