docs: add agent workflow rules
This commit is contained in:
parent
034cfdf855
commit
a2caccd357
27
AGENTS.md
Normal file
27
AGENTS.md
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
# VideoTools Agent Workflow Rules
|
||||||
|
|
||||||
|
These rules apply to any automation or agent working in this repo.
|
||||||
|
|
||||||
|
## Commit Discipline
|
||||||
|
|
||||||
|
- After every change: `git add` then `git commit -m "..."`.
|
||||||
|
- Do not leave unstaged changes in the worktree.
|
||||||
|
- Commit only files related to the current task.
|
||||||
|
|
||||||
|
## Documentation Discipline
|
||||||
|
|
||||||
|
- If behavior changes, update:
|
||||||
|
- `docs/INSTALLATION.md`
|
||||||
|
- the relevant platform guide (`docs/INSTALL_WINDOWS.md`, `docs/INSTALL_LINUX.md`)
|
||||||
|
- Always update `DONE.md` and `TODO.md` for completed or planned work.
|
||||||
|
- Avoid personal names in documentation; use `user report` or `dev report` only.
|
||||||
|
|
||||||
|
## Windows Install Flow
|
||||||
|
|
||||||
|
- Use `scripts\install.ps1` or `scripts\install.bat` from PowerShell/CMD.
|
||||||
|
- `scripts/install.sh` is for bash shells only; do not run it from PowerShell.
|
||||||
|
|
||||||
|
## Coordination
|
||||||
|
|
||||||
|
- Ask before changing workflow entrypoints or automation behavior.
|
||||||
|
- If a change affects installs/builds, add a short note in docs.
|
||||||
2
DONE.md
2
DONE.md
|
|
@ -36,6 +36,8 @@
|
||||||
- Added `scripts/install.ps1` and `scripts/install.bat` to keep the Windows workflow inside PowerShell/CMD.
|
- Added `scripts/install.ps1` and `scripts/install.bat` to keep the Windows workflow inside PowerShell/CMD.
|
||||||
- ✅ **Windows setup launcher alignment**
|
- ✅ **Windows setup launcher alignment**
|
||||||
- `setup-windows.bat` now delegates to `scripts/install.bat` for a single Windows flow.
|
- `setup-windows.bat` now delegates to `scripts/install.bat` for a single Windows flow.
|
||||||
|
- ✅ **Agent workflow rules**
|
||||||
|
- Added `AGENTS.md` to enforce staging, commits, and documentation updates.
|
||||||
|
|
||||||
## Version 0.1.0-dev25 (2026-01-22) - Settings Preferences Expansion
|
## Version 0.1.0-dev25 (2026-01-22) - Settings Preferences Expansion
|
||||||
|
|
||||||
|
|
|
||||||
2
TODO.md
2
TODO.md
|
|
@ -22,6 +22,8 @@ This file tracks upcoming features, improvements, and known issues.
|
||||||
- Provide `scripts/install.ps1` and `scripts/install.bat` to avoid Git Bash pop-ups.
|
- Provide `scripts/install.ps1` and `scripts/install.bat` to avoid Git Bash pop-ups.
|
||||||
- [X] **Windows setup launcher alignment**
|
- [X] **Windows setup launcher alignment**
|
||||||
- Route `setup-windows.bat` through `scripts/install.bat`.
|
- Route `setup-windows.bat` through `scripts/install.bat`.
|
||||||
|
- [X] **Agent workflow rules**
|
||||||
|
- Add `AGENTS.md` to enforce staging, commits, and documentation updates.
|
||||||
|
|
||||||
## Documentation: Fix Structural Errors
|
## Documentation: Fix Structural Errors
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user