docs: enforce questions-first process; remove proposal/plan; update AGENTS and SeedPrompt
This commit is contained in:
@@ -9,6 +9,11 @@ Scope: Applies to the entire repository unless overridden by a deeper AGENTS.md.
|
||||
- Examples: `collab/questions/00-bootstrap.md`, `collab/proposals/01-wrapper.md`, `collab/plan/01-wrapper.md`
|
||||
- Principle: Keep chat minimal; prefer file-based collaboration via these documents.
|
||||
|
||||
### Sequencing Rules
|
||||
- Begin with a questions file in `collab/questions/` and iterate there until the agent is satisfied or the user instructs to proceed.
|
||||
- Do not create a proposal or plan until the questions have been edited by the user and explicitly approved.
|
||||
- After approval, create a concise proposal in `collab/proposals/` and a concrete plan in `collab/plan/`, then implement.
|
||||
|
||||
## Logs and Documentation
|
||||
- Dev logs: `devlog/DEVLOG_LLM.md` and `devlog/DEVLOG_HUMAN.md` updated each meaningful change.
|
||||
- Project docs: `docs/` for feature docs (`<feature>.md`) and architectural decisions (`adr-<feature>.md`).
|
||||
|
@@ -50,3 +50,8 @@ Commit/push everything in the repo now before we get started on the project.
|
||||
### Chat Output Preference
|
||||
|
||||
- Keep chat output concise and minimal. The primary collaboration interface is via repository files (collab/, devlog/, docs/). Use chat only for brief status updates or to announce next actions.
|
||||
|
||||
### Collaboration Sequencing
|
||||
|
||||
- Start with questions in `collab/questions/` and keep iterating/adding questions until satisfied or instructed to move on.
|
||||
- Do not create proposals or plans until the questions file has been edited by the user and the user gives explicit approval.
|
||||
|
@@ -1,10 +0,0 @@
|
||||
# 00 — Bootstrap — Plan
|
||||
|
||||
1. Create `collab/` directory for coordination artifacts.
|
||||
2. Move `QUESTIONS.md` to `collab/questions/00-bootstrap.md`.
|
||||
3. Add `collab/proposals/00-bootstrap.md` and this plan file at `collab/plan/00-bootstrap.md`.
|
||||
4. Create `AGENTS.md` capturing repository working agreements.
|
||||
5. Append Addendum to `SeedPrompt.md` describing the new structure.
|
||||
6. Commit and push changes to `main`.
|
||||
|
||||
Status: pending review/confirmation.
|
@@ -1,19 +0,0 @@
|
||||
# 00 — Bootstrap — Proposal
|
||||
|
||||
Purpose: Formalize the collaboration scaffolding and initial workflow.
|
||||
|
||||
Scope:
|
||||
- Use `collab/` directory to host questions, proposals, and plans.
|
||||
- Adopt filename pattern: `<step-or-subject>-<type>.md`, where `<type>` ∈ {`questions`, `proposal`, `plan`}.
|
||||
- Maintain `AGENTS.md` with working conventions and agent guidance.
|
||||
|
||||
Deliverables (this step):
|
||||
- collab/questions/00-bootstrap.md (moved from root QUESTIONS.md)
|
||||
- collab/proposals/00-bootstrap.md (this file)
|
||||
- collab/plan/00-bootstrap.md (skeleton)
|
||||
- AGENTS.md (initial content)
|
||||
- SeedPrompt.md updated with an Addendum describing this structure
|
||||
|
||||
Acceptance Criteria:
|
||||
- Repo contains the above files with agreed naming scheme.
|
||||
- CI not required; manual review suffices for this step.
|
@@ -2,30 +2,90 @@
|
||||
|
||||
These questions guide the initial design and implementation. Please answer inline.
|
||||
|
||||
Process note: We will continue to add or refine questions here until you approve this questions file. Only after approval will we draft a proposal and a plan.
|
||||
|
||||
## Repo & workflow
|
||||
1. Git remote: Should we push to an existing remote? If yes, provide the remote URL and branch (default `origin main`).
|
||||
|
||||
Yes. Remote is already setup, origin main works.
|
||||
|
||||
2. Tagging: Use `YYYY-MM-DD-HHMM` in local time or UTC? Use `tea` only for tagging/releases, or also for pushes?
|
||||
|
||||
local time
|
||||
I'll leave it to you to utilize git/tea commands how you see fit. That's an implementation detail as far as i'm concerned.
|
||||
|
||||
3. Commit cadence: Any specific commit style (e.g., Conventional Commits)?
|
||||
|
||||
Yes Conventional Commits always.
|
||||
|
||||
## codex-cli wrapper
|
||||
4. codex-cli path: How is `codex`/`codex-cli` invoked in your environment (command name, install path)?
|
||||
|
||||
Use which to figure out the path, I am not sure.
|
||||
For now, I use
|
||||
|
||||
codex --sandbox workspace-write --full-auto
|
||||
|
||||
(We will need to let those options be set as well)
|
||||
|
||||
5. Defaults: Preferred default model, token budget, and reasoning level?
|
||||
|
||||
I am not sure. I've been happy with the defaults out of the box so far.
|
||||
|
||||
|
||||
6. Config precedence: Order of overrides? (e.g., CLI flags > env vars > project config > mode config > global defaults)
|
||||
|
||||
yes I think so. I believe that is the common convention?
|
||||
|
||||
In my mind, a project config would be a complete collection of everything needed and packed into a shell script that fires
|
||||
up codex and feeds it the project/mode/system prompt.
|
||||
|
||||
|
||||
7. Config files: Desired locations/names? (e.g., `.codexrc`, `.codex/mode.yaml`, `project.yaml`)
|
||||
|
||||
I don't want anything in a user home directory. I want it all contained in a project.
|
||||
|
||||
|
||||
8. Prompts storage: Where to store Global System Prompt, Mode Prompt, and Project Prompt? (proposal: `modes/<name>/system.md`, `modes/<name>/mode.md`, `projects/<name>/prompt.md`)
|
||||
|
||||
Right.
|
||||
|
||||
I don't want projects under this directory/repository. I don't want to pollute this repository with projects. They would go in a sibling directory or anywhere else the user wants them. This repository is just for the scaffolding project itself (shell script, example configs, template scaffolding for projects and modes) and of course the various modes themselves (and an example project of a resume rewriter to match to a job description).
|
||||
|
||||
|
||||
9. MCP configuration: Expected format and location? (JSON/YAML/TOML; per-mode vs per-project)
|
||||
|
||||
I believe it would be a mix of per-mode (defaults) and per-project (as needed). So, for example, a software mode project at TSYS (my company) would have Cloudron/Gitea/Redmine MCP servers by default and then the project may add in language specific MCP servers. I am not sure how to handle MCP, I want to tackle that last, as it's quite complex. (Ensure you create and maintain a ROADMAP.md file in the docs direcotry).
|
||||
|
||||
## Wizards
|
||||
10. Mode wizard fields: Minimum fields for a mode (name, description, defaults, prompts, MCP config)? Any templates you prefer?
|
||||
11. Project wizard fields: Minimum fields for a project (name, path, project prompt, default mode, overrides)?
|
||||
|
||||
Yes I think that's fine for now.
|
||||
|
||||
## Execution behavior
|
||||
12. Mode selection: CLI flags `--mode`, `--project`, and optional `--prompt-file` acceptable?
|
||||
|
||||
Hmmmm. I think just --mode. So heres my thinking... I would create and clone a new git repo somewhere in my home directory. I would have this shell script added to my path. I would go to my newly cloned repo, and I would run CodexHelper --mode SAASApp (let's say) and that would then scaffold a project of that mode? I'm struggling a bit to articulate what I want and think through the usage/implementation. I suppose maybe it would be combo of --mode and --new-project or something like that? Basically I'm tired of maintaining a library of markdown files that I cobble together in each new project I run codex in. I want a way to streamline that.
|
||||
|
||||
13. Non-interactive: Should wrapper fully resolve configs non-interactively by default, with an `--interactive` flag for wizard-like prompting?
|
||||
|
||||
Hmmm. I am not sure. I haven't fully thought through the usage modes yet.
|
||||
|
||||
14. Output handling: Where to log transcripts or runs? (proposal: `runs/<timestamp>/…`)
|
||||
|
||||
That should NOT be in this project/directory. It should be wherever the script is invoked from. If the script is invoked in this repo working directory, it should only be for creating new modes. (or of course running unit tests etc)
|
||||
|
||||
15. Safety: Any commands that must never be executed without confirmation?
|
||||
|
||||
Hmmm. I am not sure. I haven't fully thought through the usage modes yet. Open to suggestions/trying things out.
|
||||
|
||||
|
||||
## Misc
|
||||
16. Licensing/headers: Any repo-specific requirements beyond the existing LICENSE?
|
||||
|
||||
I want to clearly state that this repo is AGPLv3 (code/prompts) but NOT anything the user writes in their project specific prompt and any code they generate. Basically the "code" (shell script/prompt files) in this repo is AGPLv3 but the "data" (any artifacts they write or codex creates with them) is up to them to license.
|
||||
|
||||
17. Supported OS/shells: Target bash/zsh on macOS/Linux, anything else?
|
||||
|
||||
Lets say Ubuntu 22.04/Debian 12 or later.
|
||||
|
@@ -31,4 +31,15 @@ Details:
|
||||
- Establishes consistent file-based collaboration area and naming scheme.
|
||||
|
||||
Next Steps:
|
||||
- Await answers to bootstrap questions, then draft proposal and plan for wrapper.
|
||||
- Await answers to bootstrap questions. Only after you approve the questions file will we draft a proposal and plan.
|
||||
|
||||
---
|
||||
|
||||
Date: 2025-09-17 09:15 (UTC)
|
||||
|
||||
Summary:
|
||||
- Removed initial proposal and plan files per process update.
|
||||
- Updated AGENTS.md and SeedPrompt addendum to encode sequencing rules (questions → approval → proposal/plan → implement).
|
||||
|
||||
Next Steps:
|
||||
- Wait for your edits/approval in `collab/questions/00-bootstrap.md`.
|
||||
|
@@ -17,11 +17,20 @@ This log is concise and structured for quick machine parsing and summarization.
|
||||
- context: Housekeeping structure introduced
|
||||
- actions:
|
||||
- Created `collab/` directory and moved questions to `collab/questions/00-bootstrap.md`
|
||||
- Added `collab/proposals/00-bootstrap.md` and `collab/plan/00-bootstrap.md`
|
||||
- Added collaboration structure docs in `AGENTS.md` and SeedPrompt addendum
|
||||
- Added `AGENTS.md`
|
||||
- Appended housekeeping Addendum to `SeedPrompt.md`
|
||||
- decisions:
|
||||
- Adopt filename pattern `<step-or-subject>-<type>.md` for collab artifacts
|
||||
- next:
|
||||
- Await answers in `collab/questions/00-bootstrap.md`
|
||||
- Then fill proposal/plan and proceed to implementation
|
||||
- Await answers in `collab/questions/00-bootstrap.md`; only after approval, create proposal and plan
|
||||
|
||||
## 2025-09-17T09:15Z
|
||||
- context: Process sequencing refined per user request
|
||||
- actions:
|
||||
- Removed `collab/proposals/00-bootstrap.md` and `collab/plan/00-bootstrap.md`
|
||||
- Updated AGENTS.md and SeedPrompt addendum with sequencing rules
|
||||
- decisions:
|
||||
- Proposals/plans only after questions approved
|
||||
- next:
|
||||
- Wait for questions file edits/approval
|
||||
|
Reference in New Issue
Block a user