28 lines
1.8 KiB
Markdown
28 lines
1.8 KiB
Markdown
# TeamIDE Methodology
|
|
|
|
Project templates, coding conventions, and the build-plan → PM scaffolding rules that [TeamIDE](https://teamide.dev)'s planner agent reads at run time.
|
|
|
|
This repo is the public, version-controlled source of truth for **how a TeamIDE project gets shaped**:
|
|
|
|
- `claude.md` — the methodology guide: how to plan a project, the spec/plan/PM-file pipeline, naming conventions, the file structure every project follows, and the docs/InternalDocs split.
|
|
- `templates/coding-best-practices.md` — universal coding rules (descriptive names, small functions, library-first design, file-header convention, no auto-save).
|
|
- `templates/claude.md` — the standard project CLAUDE.md template (copied and customized into every new project).
|
|
- `templates/TauriStarter/` — a working Tauri + Quasar + Vite desktop-app starter.
|
|
- `templates/ResearchStarter/` — a hypothesis-first R&D starter.
|
|
- `templates/teamide/` — `.teamide/project.yml` and `.teamide/plans/` / `.teamide/tasks/` scaffolding.
|
|
- `templates/docs/` — documentation templates (`feature-*.md`, `getting-started.md`, etc.).
|
|
|
|
## How TeamIDE consumes this
|
|
|
|
TeamIDE clones this repo to `~/TeamIDE/.data/methodology/` on first launch and refreshes it on demand (manual button in the planner UI, or `git pull` on app start — TBD). The planner agent has **read-only** access to this directory. Writes outside its working dir are forbidden by the prompt.
|
|
|
|
If you want to customize TeamIDE's planner with your own templates or conventions, fork this repo and point TeamIDE at your fork (configurable in the planner settings).
|
|
|
|
## Status
|
|
|
|
Living document — extracted from an earlier private repo on 2026-05-16 to support TeamIDE's planner/conductor agent pipeline (see TeamIDE's `workspace-projects-agent-spec.md` §9.4).
|
|
|
|
## License
|
|
|
|
[MIT Transparency License](./LICENSE) — same as TeamIDE itself.
|