Skip to content

Latest commit

 

History

History
64 lines (46 loc) · 1.82 KB

File metadata and controls

64 lines (46 loc) · 1.82 KB

AGENTS.md

GitHub Copilot agent mode workshop: Build an OctoFit Tracker fitness app with React frontend, Django REST backend, and MongoDB database in GitHub Codespaces.

Boundaries

⚠️ Ask first:

  • Modifying .github/workflows/ (affects exercise validation)
  • Changing .github/instructions/ (affects other Copilot sessions)
  • Modifying exercise steps in .github/steps/ (affects workshop flow)

🚫 Never:

  • Using ports other than 8000 (Django), 3000 (React), 27017 (MongoDB)
  • Creating virtual environments outside octofit-tracker/backend/venv/
  • Modifying .devcontainer/ configuration

Documentation Standards

  • Use ATX-style headers (# not ===)
  • One sentence per line for easier diffs
  • Use relative links for internal references
  • Use neutral theme for Mermaid diagrams:
```mermaid
%%{init: {'theme': 'neutral'}}%%
graph TD
    A[Start] --> B[End]
```
  • Use colors to improve diagram readability (decisions, outcomes, categories):
```mermaid
%%{init: {'theme': 'neutral'}}%%
flowchart TD
    Start["Question"] --> Decision{"Choice?"}
    Decision -->|Yes| OptionA[["Option A"]]
    Decision -->|No| OptionB[["Option B"]]

    style Start fill:#e1e1e1,stroke:#333,stroke-width:2px
    style Decision fill:#fff3cd,stroke:#856404,stroke-width:2px
    style OptionA fill:#d4edda,stroke:#155724,stroke-width:2px
    style OptionB fill:#cce5ff,stroke:#004085,stroke-width:2px
```

Troubleshooting

Use the troubleshooting prompt for automatic fixes:

/fix-step <step_number>

See TROUBLESHOOTING.md for detailed guidance.

Additional Guidance