grok-project-scope

Files (200)

• README.md
• SKILL.md
• TAXONOMY.md
• SKILL.md · browser-brave-history/
• index.json · browser-brave-history/
• SKILL.md · browser-brave-shield/
• index.json · browser-brave-shield/
• SKILL.md · browser-brave-wallet/
• index.json · browser-brave-wallet/
• SKILL.md · browser-cache-artifact-recover/
• index.json · browser-cache-artifact-recover/
• SKILL.md · browser-chrome-cache-recover/
• index.json · browser-chrome-cache-recover/
• SKILL.md · browser-chrome-cookie/
• index.json · browser-chrome-cookie/
• SKILL.md · browser-chrome-extension/
• index.json · browser-chrome-extension/
• SKILL.md · browser-chrome-history/
• index.json · browser-chrome-history/
• SKILL.md · browser-chrome-indexeddb/
• index.json · browser-chrome-indexeddb/
• SKILL.md · browser-chrome-password/
• index.json · browser-chrome-password/
• SKILL.md · browser-chromium-credential/
• index.json · browser-chromium-credential/
• SKILL.md · browser-chromium-localstorage/
• index.json · browser-chromium-localstorage/
• SKILL.md · browser-chromium-session-reconstruct/
• index.json · browser-chromium-session-reconstruct/
• SKILL.md · browser-credential-saved/
• index.json · browser-credential-saved/
• SKILL.md · browser-extension-malicious/
• index.json · browser-extension-malicious/
• SKILL.md · browser-extension-manifest/
• index.json · browser-extension-manifest/
• SKILL.md · browser-firefox-addon/
• index.json · browser-firefox-addon/
• SKILL.md · browser-firefox-cookie/
• index.json · browser-firefox-cookie/
• SKILL.md · browser-firefox-history/
• index.json · browser-firefox-history/
• SKILL.md · browser-firefox-profile/
• index.json · browser-firefox-profile/
• SKILL.md · browser-forensics-artifact/
• index.json · browser-forensics-artifact/
• SKILL.md · browser-forensics-hunt/
• index.json · browser-forensics-hunt/
• SKILL.md · browser-phishing-fingerprint/
• index.json · browser-phishing-fingerprint/
• SKILL.md · browser/brave/history/analyze/
• index.json · browser/brave/history/analyze/
• index.json · browser/brave/history/
• index.json · browser/brave/
• SKILL.md · browser/brave/shield/analyze/
• index.json · browser/brave/shield/analyze/
• index.json · browser/brave/shield/
• SKILL.md · browser/brave/wallet/extract/
• index.json · browser/brave/wallet/extract/
• index.json · browser/brave/wallet/
• index.json · browser/cache/artifact/
• …and 140 more

SKILL.md (first lines)

# Grok Project Scope Skill

## Purpose
This skill guarantees that every project maintained inside `/home/workdir/GrokProjects` has a **rigorously defined, version-controlled, and strictly adhered-to scope**. It works hand-in-hand with the grok-projects-workspace skill to provide per-project governance: clear objectives, explicit in/out-of-scope boundaries, success metrics, and change-control processes. This prevents feature creep, ensures alignment with DystopianOS principles, and keeps the single source of truth repository accurate and auditable.

## Instructions

**Core Workflow – Execute these steps in order every time this skill is active:**

**Visual cue — scope document (its explicit intention):**  
This `assets/scope-icon.png` reference exists for one precise reason: to embed a visual reminder that tells the user (and every future agent) to **click the folder icon in the Grok chat UI**. Doing so instantly opens the file tree directly to the synchronized workspace at `/home/workdir/GrokProjects` and highlights the active project's `SCOPE.md`.  

![Scope Document — click to open project scope](assets/scope-icon.png)

1. **Prerequisite Workspace Sync** (always run grok-projects-workspace first):
   ```bash
   # Ensure the shared workspace is fully synchronized before scoping any project
   mkdir -p /home/workdir/GrokProjects
   if [ ! -d "/home/workdir/GrokProjects/.git" ]; then
     if ! git clone https://github.com/DCx7C5/grok-projects-workspace.git /home/workdir/GrokProjects 2>/dev/null; then
       echo "⚠️ Remote unavailable. Creating local workspace..."
       cd /home/workdir/GrokProjects
       git init
       mkdir -p pipelines templates repos docs
       echo '# Grok Projects Workspace (Local Fallback)' > README.md
       git add .
       git commit -m "chore: initial local workspace setup"
     fi
   else
     cd /home/workdir/GrokProjects && git pull --rebase
   fi
   cd /home/workdir/GrokProjects
   mkdir -p repos
   ```

2. **Explicit File Path & Project Validation** (run immediately after workspace sync):
   ```bash
   WORKSPACE="/home/workdir/GrokProjects"
   if [ ! -d "$WORKSPACE" ]; then
     echo "❌ Workspace directory missing: $WORKSPACE"
     exit 1
   fi
   cd "$WORKSPACE" || { echo "❌ Cannot enter workspace"; exit 1; }
   RESOLVED_PATH="$(realpath "$WORKSPACE")"
   if [ "$RESOLVED_PATH" != "/home/workdir/GrokProjects" ]; then
     echo "❌ CRITICAL PATH VALIDATION FAILED"
     exit 1
   fi
   echo "✅ Workspace validation passed: $(pwd)"
   mkdir -p repos pipelines templates docs
   ```

3. **Identify or Initialize Project Scope**:
   - Ask the user for the project name if not obvious from context or conversation history.
   - Sanitize name (lowercase, hyphens only, no spaces).
   - Create project directory if missing: `mkdir -p "repos/$PROJECT_NAME"`
   - Ensure `SCOPE.md` exists in the project root. If not, generate the standard template below.

   **Standard SCOPE.md Template** (write this if missing or incomplete using heredoc):
   ```bash
   cat > "repos/$PROJECT_NAME/SCOPE.md" << 'EOF'
   # Project Scope: [PROJECT_NAME]

   ## Objective
   [One-sentence mission statement — what this project achieves]

   ## In Scope
   - Primary deliverable 1
   - Primary deliverable 2
   - Supporting features / integrations
   - Documentation and tests

   ## Out of Scope
   - Explicitly excluded items (e.g. unrelated features, future phases)
   - Nice-to-haves deferred to later projects

   ## Success Criteria
   - Measurable goal 1 (e.g. "All pipelines pass with >95% coverage")
   - Measurable goal 2 (e.g. "Deployed and validated in staging")

   ## Key Constraints & Assumptions
   - Tech stack: Python 3.12+, specific libraries...
   - Dependencies on other GrokProjects components
   - Timeline / milestones
   - Resource limits

   ## Change Control Process
   All scope changes require:
   1. Update this SCOPE.md document
   2. Commit using conventional message: "docs(scope): describe the boundary change"
   3. Immediate push to remote repository
   4. Re-confirmation with user before proceeding with new work

   ## Concurrent Work Policy (Mandatory)
   Multiple agents in different chats **must** use `git worktree`.
   - All agent work happens in isolated worktrees under `.worktrees/<chat-id>/`
   - Never work directly in the main project root when other agents are active
   - Create worktree with:
     ```bash
     git worktree add -b "agent/chat-$$" ".worktrees/chat-$$"
     cd ".worktrees/chat-$$"
     ```
   - Clean up when done: `git worktree remove ".worktrees/chat-$$"`

   *Last updated: $(date +%Y-%m-%d) by Grok Project Scope Skill — Worktree policy enforced*
   EOF
   echo "✅ SCOPE.md template created/updated for $PROJECT_NAME"
   ```

4. **Instruct the user** to click the folder icon (see image above) to open the file tree, navigate to `repos/[project-name]/SCOPE.md`, and review/confirm the current scope before any implementation work begins.

5. **Communicate the Scope Governance Rules** clearly:
   - This `SCOPE.md` is the **binding contract** for all work on this project.
   - Every task, script, commit, or change **must** be directly traceable to an item listed under "In Scope".
   - Scope creep is explicitly forbidden — any proposed addition, no matter how small, must first result in an updated SCOPE.md, user confirmation, commit, and push.
   - The GrokProjects repository is the single source of truth; scope definitions must never live in chat history, external notes, or uncommitted files.

6. **Enforce Clean Scope Workflow**:
   - At the beginning of every session involving this project: display the full SCOPE.md and obtain explicit user confirmation that the current task aligns with it.

From DCx7C5/ai-marketplace, MIT.