Skip to content

Commit 9bab876

Browse files
authored
Merge pull request #21 from hatlabs/docs/add-workspace-reference
docs: Add workspace reference for agentic coding
2 parents 169df0f + b4851ab commit 9bab876

3 files changed

Lines changed: 98 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
⚠️ **THESE RULES ONLY APPLY TO FILES IN /apt.hatlabs.fi/** ⚠️
2+
3+
# Hat Labs APT Repository - Development Guide
4+
5+
## 🎯 For Agentic Coding: Use the HaLOS Workspace
6+
7+
This repository should be used as part of the halos-distro workspace for AI-assisted development:
8+
9+
```bash
10+
# Clone workspace and all repos
11+
git clone https://github.com/hatlabs/halos-distro.git
12+
cd halos-distro
13+
./run repos:clone
14+
```
15+
16+
See `halos-distro/docs/` for development workflows and guidance.
17+
18+
## About This Project
19+
20+
APT repository infrastructure for Hat Labs packages and tools.
21+
22+
**Local Instructions**: For environment-specific instructions and configurations, see @CLAUDE.local.md (not committed to version control).
23+
24+
## Git Workflow Policy
25+
26+
**Branch Workflow:** Never push to main directly - always use feature branches and PRs.
27+
28+
## Issue Creation & Implementation
29+
30+
**MANDATORY:** All GitHub issues must require following `halos-distro/docs/IMPLEMENTATION_CHECKLIST.md` during implementation. Include this requirement in the issue body when creating issues.
31+
32+
## Development Workflow
33+
34+
**MANDATORY:** Follow `halos-distro/docs/DEVELOPMENT_WORKFLOW.md` for ALL implementations.
35+
36+
**Standard Workflow for All Features:**
37+
38+
1. **EXPLORE** - Read relevant code WITHOUT writing any code
39+
- Use `Task tool with subagent_type=Explore` for complex navigation
40+
- Reference relevant documentation
41+
2. **PLAN** - Create implementation approach
42+
- Use `think hard` for planning
43+
- Document the plan before coding
44+
3. **TEST** - Write tests FIRST (TDD)
45+
- Write comprehensive tests
46+
- Verify tests fail
47+
- Commit tests
48+
4. **IMPLEMENT** - Code until tests pass
49+
- Follow the plan
50+
- Don't modify tests
51+
- Iterate until all pass
52+
5. **VERIFY** - Check implementation quality
53+
- Use subagents for verification
54+
- Check for edge cases
55+
6. **COMMIT** to a feature branch
56+
7. **CREATE PR** and push to remote
57+
8. **WAIT** for CI checks
58+
9. **CHECK PR status** - verify tests pass, review feedback
59+
10. **ITERATE** if needed, then merge
60+
61+
## Repository Structure
62+
63+
This repository maintains the Hat Labs APT repository at https://apt.hatlabs.fi.
64+
65+
- **scripts/**: Repository management scripts
66+
- **docs/**: Documentation
67+
- **.github/workflows/**: CI/CD automation
68+
- **gh-pages branch**: Published APT repository content
69+
70+
## Related
71+
72+
- **Parent**: [../AGENTS.md](../AGENTS.md) - Workspace documentation
73+
- **Packages**: Built from halos-marine-containers, cockpit-apt, runtipi-docker-service, etc.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
11
# Hat Labs APT repository
22

3-
This is the APT repository for Hat Labs. It contains packages and tools for use with our systems.
3+
This is the APT repository for Hat Labs. It contains packages and tools for use with our devices and with HaLOS (Hat Labs Operating System).
4+
5+
To use this repository, follow the instructions at [apt.hatlabs.fi](https://apt.hatlabs.fi).
6+
7+
## Agentic Coding Setup (Claude Code, GitHub Copilot, etc.)
8+
9+
For development with AI assistants, use the halos-distro workspace for full context:
10+
11+
```bash
12+
# Clone the workspace
13+
git clone https://github.com/hatlabs/halos-distro.git
14+
cd halos-distro
15+
16+
# Get all sub-repositories including apt.hatlabs.fi
17+
./run repos:clone
18+
19+
# Work from workspace root for AI-assisted development
20+
# Claude Code gets full context across all repos
21+
```
22+
23+
See `halos-distro/docs/` for development workflows:
24+
- `HUMAN_DEVELOPMENT_GUIDANCE.md` - Quick start guide
25+
- `IMPLEMENTATION_CHECKLIST.md` - Development checklist
26+
- `DEVELOPMENT_WORKFLOW.md` - Detailed workflows

0 commit comments

Comments
 (0)