chore: Add project configuration and documentation
Some checks failed
Build and Test / build (push) Has been cancelled
Some checks failed
Build and Test / build (push) Has been cancelled
- Kilocode AI agent rules and guidelines - Setup and implementation guides - Architecture documentation - Build and verification references
This commit is contained in:
169
OMS_IMPLEMENTATION_START.md
Normal file
169
OMS_IMPLEMENTATION_START.md
Normal file
@@ -0,0 +1,169 @@
|
||||
# ✅ OMS Implementation - Ready to Start!
|
||||
|
||||
**Date:** February 15, 2026
|
||||
**Repository:** C:\dev\nt8-sdk
|
||||
**Status:** ALL FILES READY
|
||||
|
||||
---
|
||||
|
||||
## 📋 OMS Documentation Files (In Repository)
|
||||
|
||||
✅ **OMS_Design_Specification.md** (42 KB)
|
||||
- Complete technical design
|
||||
- Interface definitions
|
||||
- State machine specification
|
||||
- Implementation requirements
|
||||
|
||||
✅ **Kilocode_Implementation_Guide.md** (40 KB)
|
||||
- Step-by-step task breakdown
|
||||
- Phase A-E detailed instructions
|
||||
- Code templates and examples
|
||||
- Verification steps
|
||||
|
||||
✅ **OMS_Test_Scenarios.md** (18 KB)
|
||||
- 50+ comprehensive test cases
|
||||
- Edge case coverage
|
||||
- Performance benchmarks
|
||||
- Test data builders
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Ready to Start with Kilocode
|
||||
|
||||
### OPTION 1: Code Mode (Recommended)
|
||||
|
||||
**Use this for direct implementation following the guide.**
|
||||
|
||||
**Paste into Kilocode Code Mode:**
|
||||
|
||||
```
|
||||
I'm ready to implement the OMS (Order Management System).
|
||||
|
||||
I will follow the task breakdown in Kilocode_Implementation_Guide.md
|
||||
starting with Task A1: Create OrderModels.cs
|
||||
|
||||
Please confirm you've loaded all rules from .kilocode/rules/
|
||||
and understand:
|
||||
- C# 5.0 syntax requirements (no $, ?., =>)
|
||||
- File modification boundaries (OMS directories only)
|
||||
- Mandatory coding patterns (locks, try-catch, logging)
|
||||
- Verification requirements (verify-build.bat after each file)
|
||||
- Project context (production trading code)
|
||||
|
||||
Let's start with creating OrderModels.cs in src/NT8.Core/OMS/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### OPTION 2: Architect Mode (If You Want Design Review First)
|
||||
|
||||
**Use this if you want Kilocode to review the design before coding.**
|
||||
|
||||
**Paste into Kilocode Architect Mode:**
|
||||
|
||||
```
|
||||
Review the OMS design in OMS_Design_Specification.md and
|
||||
Kilocode_Implementation_Guide.md
|
||||
|
||||
Analyze:
|
||||
1. Are there any design issues or improvements needed?
|
||||
2. Is the implementation plan optimal?
|
||||
3. Any risks or concerns before we start coding?
|
||||
|
||||
After review, we'll switch to Code Mode for implementation.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📂 File Locations
|
||||
|
||||
All documentation is in your repository root:
|
||||
|
||||
```
|
||||
C:\dev\nt8-sdk\
|
||||
├── OMS_Design_Specification.md ✅ 42 KB
|
||||
├── Kilocode_Implementation_Guide.md ✅ 40 KB
|
||||
├── OMS_Test_Scenarios.md ✅ 18 KB
|
||||
├── KILOCODE_SETUP_COMPLETE.md ✅ Setup guide
|
||||
└── BUILD_WARNINGS_REFERENCE.md ✅ Build info
|
||||
```
|
||||
|
||||
Implementation code will go in:
|
||||
```
|
||||
src/NT8.Core/OMS/ ← Implementation files
|
||||
tests/NT8.Core.Tests/OMS/ ← Unit tests
|
||||
tests/NT8.Core.Tests/Mocks/ ← Mock adapters
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⏱️ Implementation Timeline
|
||||
|
||||
**Total Estimated Time:** 6 hours
|
||||
|
||||
| Phase | Task | Time | Files |
|
||||
|-------|------|------|-------|
|
||||
| **A** | Core Models & Interfaces | 30 min | 3 files |
|
||||
| **B** | BasicOrderManager | 2 hours | 1 file |
|
||||
| **C** | Mock Adapter | 30 min | 1 file |
|
||||
| **D** | Unit Tests | 2 hours | 5 test files |
|
||||
| **E** | Verification | 30 min | Validation |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Next Actions
|
||||
|
||||
**STEP 1:** Open Kilocode panel in VS Code
|
||||
|
||||
**STEP 2:** Choose your mode:
|
||||
- **Code Mode** → Direct implementation (faster)
|
||||
- **Architect Mode** → Design review first (safer)
|
||||
|
||||
**STEP 3:** Paste the appropriate starter prompt from above
|
||||
|
||||
**STEP 4:** Confirm Kilocode has loaded the rules (should see 12 rules)
|
||||
|
||||
**STEP 5:** Begin implementation following the guide
|
||||
|
||||
---
|
||||
|
||||
## ✅ Pre-Flight Checklist
|
||||
|
||||
Before starting, verify:
|
||||
|
||||
- [ ] VS Code restarted (to load Kilocode rules)
|
||||
- [ ] Kilocode panel open
|
||||
- [ ] Law icon (⚖️) shows 12 rules loaded
|
||||
- [ ] Build is clean (`Ctrl+Shift+B` works)
|
||||
- [ ] All 3 OMS documents visible in repo root
|
||||
- [ ] Ready to commit ~6 hours to implementation
|
||||
|
||||
---
|
||||
|
||||
## 💡 Recommendation
|
||||
|
||||
**Use Code Mode** because:
|
||||
1. ✅ Design is complete and detailed
|
||||
2. ✅ Implementation guide is step-by-step
|
||||
3. ✅ Rules enforce quality automatically
|
||||
4. ✅ Faster path to working OMS
|
||||
|
||||
Switch to Architect Mode only if you hit unexpected design issues.
|
||||
|
||||
---
|
||||
|
||||
## 📞 During Implementation
|
||||
|
||||
If you need to:
|
||||
- **Pause**: Just stop, Kilocode will resume from last file
|
||||
- **Switch modes**: Close and reopen Kilocode in different mode
|
||||
- **Get help**: Reference the design spec or test scenarios
|
||||
- **Verify**: Run `Ctrl+Shift+B` after each file
|
||||
|
||||
---
|
||||
|
||||
**Everything is ready. Choose your mode and start!** 🚀
|
||||
|
||||
---
|
||||
|
||||
*Documentation copied to repository: February 15, 2026*
|
||||
Reference in New Issue
Block a user