Skip to content

Commit f6c9445

Browse files
authored
Restore legacy automation docs as redirects (#41)
1 parent 0f5be84 commit f6c9445

13 files changed

+469
-1330
lines changed

.github/AGENT_COLLABORATION.md

Lines changed: 76 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,20 @@
22

33
## Overview
44

5-
This guide provides comprehensive information for AI agents (GitHub Copilot, ChatGPT Codex, CodeRabbit, etc.) working on the Bleedy project. It clarifies technical constraints, communication patterns, and best practices for effective collaboration.
5+
This guide provides comprehensive information for AI copilots (GitHub Copilot Agent, ChatGPT Codex, Gemini Code Assist, Claude Code, Google Jules, CodeRabbit, etc.) working on the Bleedy project. It clarifies technical constraints, communication patterns, and best practices for effective collaboration regardless of the host platform.
6+
7+
## Agent Capability Matrix
8+
9+
| Agent | Default Commit Tooling | Network Access Profile | Key Nuances |
10+
| -------------------------- | ---------------------------------- | ---------------------------------------------------- | ---------------------------------------------------------------------------------------- |
11+
| **GitHub Copilot Agent** | `report_progress` + PR automation | GitHub MCP HTTP gateway with GitHub auth | Prefers `report_progress` checkpoints; surface `gh` helpers when configured. |
12+
| **ChatGPT Codex** | `report_progress` (GitHub-managed) | Limited outbound HTTP; GitHub REST available via MCP | Confirm branch context before each commit; Codex dashboards expect concise status notes. |
13+
| **Gemini Code Assist** | `apply_patch` + Google git proxies | Google-hosted sandbox with curated allow list | Paste explicit command outputs; document skipped steps that violate policy. |
14+
| **Claude Code** | `commit` / `open_pr` helpers | Anthropic secure proxy with audited HTTP access | Provide structured diffs and mention safety blocks when they trigger. |
15+
| **Google Jules** | `submit` workflow with auto-commit | Google-aligned HTTP allow list and strict logging | Provide deterministic QA commands and reproducible steps. |
16+
| **Other / Unknown Agents** | Varies | Assume restricted | Ask which tools are available before running niche commands. |
17+
18+
> **Tip:** When instructions conflict, follow the stricter platform rule (for example, if Gemini disallows a network call that Copilot allows, skip it and note the limitation in your response).
619
720
## Table of Contents
821

@@ -21,9 +34,9 @@ All AI agents operate in sandboxed environments with specific limitations:
2134

2235
#### Network Access
2336

24-
- **Cannot access external HTTP/HTTPS URLs** - This includes GitHub.com URLs, even for this repository
25-
- **Workaround**: Paste review comments or specific content directly into PR/issue comments
26-
- **Note**: Some agents may have internal APIs for GitHub operations (use MCP tools when available)
37+
- **Limited outbound HTTP/HTTPS access is available** – agents can usually contact public APIs (including GitHub) when authenticated tooling is configured.
38+
- **Prefer repository-provided tools** – use MCP helpers or curated scripts before resorting to ad-hoc `curl`/`wget` calls.
39+
- **Mind rate limits** – cache responses when practical and avoid unnecessary polling.
2740

2841
#### Git Operations
2942

@@ -42,9 +55,10 @@ All AI agents operate in sandboxed environments with specific limitations:
4255
- ✅ Read and modify files in the repository
4356
- ✅ Run commands via bash/shell tools
4457
- ✅ Use `report_progress` to commit and push changes
45-
- ✅ Access GitHub API via MCP tools (if available)
58+
- ✅ Access GitHub API via MCP tools or authenticated CLI clients when available
4659
- ✅ Create and modify issues/PRs (via tools, not direct git)
4760
- ✅ Run builds, tests, and linters locally
61+
- ✅ Leverage the `npm run qa` helper to execute lint/build/test in one command
4862

4963
## Communication Patterns
5064

@@ -210,7 +224,7 @@ When working on tasks:
210224

211225
### Issue: "I cannot access the review comments at [GitHub URL]"
212226

213-
**Solution**: This is expected due to sandbox limitations. Ask the user:
227+
**Solution**: Some environments restrict outbound HTTP/HTTPS access. If you receive a denial, ask the user:
214228

215229
```markdown
216230
I cannot access external URLs from my sandboxed environment. Could you please paste the specific review comments here? This will allow me to address them directly.
@@ -327,48 +341,75 @@ I don't have access to changes made by other agents unless they're in the curren
327341

328342
### GitHub Copilot Agent
329343

330-
- Has access to GitHub MCP tools for repository operations
331-
- Can read issues, PRs, and comments via API
332-
- Uses `report_progress` for committing changes
333-
- Cannot access external URLs (HTTP/HTTPS)
344+
- Uses GitHub MCP to expose `report_progress`, git history lookups, and limited GitHub REST calls.
345+
- Prefers incremental commits—summarize staged changes before invoking `report_progress`.
346+
- Can run authenticated `gh` commands when configured; announce if the CLI is unavailable.
347+
348+
### ChatGPT Codex
349+
350+
- Operates through GitHub's Codex integration with opinionated status dashboards.
351+
- `report_progress` is available, but Codex expects concise summaries (≤5 bullet points) per commit.
352+
- Outbound HTTP is constrained to GitHub domains—ask users to paste external artifacts.
353+
354+
### Gemini Code Assist
355+
356+
- Relies on `apply_patch` and Google-managed git proxies instead of direct `git commit`.
357+
- Command execution is audited; paste exact outputs (trimmed for relevance) in your response body.
358+
- Flag skipped commands explicitly when policy prevents execution.
359+
360+
### Claude Code
361+
362+
- Provides `commit` and `open_pr` helpers that require a final diff summary.
363+
- Anthropic's proxy logs all outbound HTTP—note when a call may trigger safety review.
364+
- If a safety filter blocks an action, include the filter message verbatim and propose a compliant alternative.
334365

335-
### ChatGPT Codex Connector
366+
### Google Jules
336367

337-
- Operates through GitHub integration
338-
- Can create commits and interact with GitHub
339-
- Provides task tracking via Codex dashboard
340-
- May have different tool availability
368+
- Automates commits through a `submit` workflow; group related changes into one submission unless the user asks otherwise.
369+
- Emphasizes deterministic QA: list the exact commands you ran and any you intentionally skipped.
370+
- Jules integrates with Google issue trackers—reference issue IDs when available.
341371

342-
### CodeRabbit
372+
### CodeRabbit (Review Agent)
343373

344-
- Provides automated code reviews
345-
- Can be triggered with `@coderabbitai review full`
346-
- Focuses on code quality and best practices
347-
- Can suggest improvements and identify issues
374+
- Provides automated code reviews and can be triggered with `@coderabbitai review full` in PR threads.
375+
- Focuses on code quality, performance, and best practices—respond inline to each thread it opens.
348376

349377
### Other Agents
350378

351-
- May have varying capabilities
352-
- Always check available tools before starting
353-
- Document any unique limitations discovered
354-
- Update this guide with new findings
379+
- Capabilities vary; confirm available tools with `help`/`tools` commands before starting.
380+
- Document unique limitations discovered during a session for future contributors.
381+
- Update this guide via PR when you discover durable differences.
355382

356383
## Repository-Specific Guidelines
357384

358385
### Before Making Changes
359386

360387
1. Run `npm install` (patches are applied automatically)
361-
2. Verify current state: `npm run build && npm run lint`
362-
3. Review existing code style and patterns
363-
4. Check for related issues or PRs
388+
2. Confirm branch context with `git status -sb` and `git branch --show-current`
389+
3. Review recent activity via `git log --oneline --decorate --graph -5`
390+
4. Check for related issues or PRs using available tooling (for example `gh pr list --limit 20` when authenticated)
391+
5. Review existing code style and patterns
364392

365393
### After Making Changes
366394

367-
1. Run linter: `npm run lint`
368-
2. Build the project: `npm run build`
369-
3. Test manually if UI changes
370-
4. Use `report_progress` to commit changes
371-
5. Verify committed files are appropriate
395+
1. Run the unified QA helper: `npm run qa`
396+
- Add `--with-typecheck` when TypeScript validation is required
397+
- Use `--skip-tests` or related flags for documentation-only updates
398+
2. Test manually if UI changes
399+
3. Use `report_progress` to commit changes
400+
4. Verify committed files are appropriate
401+
5. Capture branch status in handoff notes (`git status -sb`)
402+
403+
### Repository Awareness Checklist
404+
405+
| Task | Command |
406+
| ----------------------------------- | --------------------------------------------------------- |
407+
| Show current branch | `git branch --show-current` |
408+
| Inspect local branches | `git branch --sort=-committerdate` |
409+
| View remote tracking info | `git remote -v` |
410+
| Summarize recent history | `git log --oneline --decorate --graph -10` |
411+
| List open PRs (requires GitHub CLI) | `gh pr list --limit 20 --search "repo:danelkay93/bleedy"` |
412+
| Check CI status for branch | `gh run list --limit 5 --branch <branch>` |
372413

373414
### Pull Request Standards
374415

@@ -382,6 +423,7 @@ I don't have access to changes made by other agents unless they're in the curren
382423
If you encounter issues not covered in this guide:
383424

384425
1. **Check existing documentation** in the repository
426+
- Start with the [Agent Toolkit Quickstart](../docs/AGENT_TOOLKIT.md) for command references
385427
2. **Ask the user** for clarification or assistance
386428
3. **Document the issue** for future reference
387429
4. **Update this guide** if you find a solution
@@ -399,5 +441,5 @@ Please update this guide in your PR with a clear explanation of the addition.
399441

400442
---
401443

402-
**Last Updated**: 2025-10-18
403-
**Maintained by**: GitHub Copilot, ChatGPT Codex, and community contributors
444+
**Last Updated**: 2024-10-29
445+
**Maintained by**: GitHub Copilot Agent, ChatGPT Codex, Gemini Code Assist, Claude Code, Google Jules, and community contributors

.github/copilot-instructions.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Copilot Instructions for Bleedy
22

3+
> Multi-agent context: For cross-platform conventions covering ChatGPT Codex, Gemini Code Assist, Claude Code, and Google Jules, see [`.github/AGENT_COLLABORATION.md`](./AGENT_COLLABORATION.md) and the [Agent Toolkit Quickstart](../docs/AGENT_TOOLKIT.md).
4+
35
## Project Overview
46

57
**Bleedy** is a web application for adding bleed margins to images, built with Vue 3, Vite, TypeScript, and PyScript. It allows users to upload images and automatically add professional bleed margins using Python image processing in the browser.
@@ -82,6 +84,16 @@ npm run lint
8284
- Configuration in `eslint.config.js` uses modern ES modules format
8385
- Automatically ignores `dist/`, `dist-ssr/`, and `node_modules/` folders
8486

87+
#### Unified QA Helper
88+
89+
```bash
90+
npm run qa
91+
```
92+
93+
- Executes ESLint, Vite build, and Vitest in sequence with helpful logging
94+
- Pass `--with-typecheck` to include the slower Vue TypeScript checks when they are required
95+
- Additional flags like `--skip-tests` are available for documentation-only updates
96+
8597
#### Prettier
8698

8799
```bash
@@ -263,9 +275,9 @@ This repository supports collaboration between multiple AI agents (GitHub Copilo
263275

264276
### Key Collaboration Points
265277

266-
**Technical Limitations**:
278+
**Technical Considerations**:
267279

268-
- AI agents cannot access external HTTP/HTTPS URLs (including github.com links)
280+
- Outbound HTTP/HTTPS access is typically available but subject to rate limits and tool configuration
269281
- Cannot push directly using `git push` - must use `report_progress` tool
270282
- Cannot resolve merge conflicts - user must handle these
271283
- Cannot access files in `.github/agents/` directory

0 commit comments

Comments
 (0)