17efc4f656
Make the project's documentation match the code and remove the sprawl. The docs
claimed Phase 2.8 (drug interactions) was 'planning/0%' and the backend '~91%
complete' — both wrong: 2.8 is implemented and live, plus the P0/P1 security
and test work is done. Five root CI/CD docs described a 'docker-build' CI job
that was removed; ~18 backend/ status snapshots and ~24 docs/implementation
duplicates cluttered the tree.
Deletions (85 files):
- Root: 4 stale CI/CD reports (CI-CD-{COMPLETION-REPORT,IMPLEMENTATION-SUMMARY,
STATUS-REPORT,FINAL-STATUS}.md) — all describe the removed docker-build job.
- backend/: 18 phase/build/fix snapshots and code-dump .txt files.
- docs/: the 3 one-time reorg reports; ~17 docs/implementation duplicates and
process artifacts; 4 stale docs/development CI docs + git snapshots;
redundant deployment/testing files.
- thoughts/: STATUS.md (said Phase 2.4 in-progress), superseded phase notes and
duplicative research inputs. tmp/ (928KB of CI debug logs, gitignored).
Moves (18 files):
- 9 genuine decision records -> docs/adr/ (Architecture Decision Records),
date-prefixes stripped, with an index README.
- 8 historical-but-valuable phase plans/specs + the old CI-CD-FINAL-SOLUTION ->
docs/archive/ (now-populated, with a README explaining it's superseded
material). thoughts/ tree removed.
Rewrites (13 files) to match reality:
- Drop the fake '% complete' figures everywhere in favor of Implemented /
In-Progress / Planned with concrete endpoint/feature lists.
- Phase 2.8 -> Implemented; add /api/interactions/* and /api/auth/{refresh,
logout} to the endpoint lists; fix 'Rust 1.93' -> edition 2021.
- Add a Security section (token_version validation, hashed refresh-token
persistence, fail-fast config, real-IP audit) and correct the test-coverage
and deployment claims to reality.
- New canonical docs/development/CI-CD.md (4 jobs: format/clippy/build/test,
mongo service, no docker-build + why).
- README, docs/README, product/{STATUS,ROADMAP,PROGRESS,README,introduction},
implementation/README, development/README, testing/README, AI_AGENT_GUIDE,
.cursorrules, .gooserules all updated.
Verified: greps for 'Phase 2.8 (Planning)', 'PLANNING (0%)', 'Rust 1.93',
'91%/10%/85% complete', and 'docker-build' return nothing outside docs/archive;
all internal doc links resolve; backend/src untouched (cargo build clean).
127 lines
2.5 KiB
Markdown
127 lines
2.5 KiB
Markdown
# Development Documentation
|
|
|
|
This section contains development workflow documentation, Git guidelines, and CI/CD configuration.
|
|
|
|
## 📚 Workflow Documentation
|
|
|
|
### Commit Guidelines
|
|
- **[COMMIT-INSTRUCTIONS.txt](./COMMIT-INSTRUCTIONS.txt)** - Commit message guidelines
|
|
|
|
## 🔄 CI/CD
|
|
|
|
### Forgejo Configuration
|
|
- **[CI-CD.md](./CI-CD.md)** - The current CI/CD pipeline (format / clippy / build / test)
|
|
|
|
## 🌳 Branch Strategy
|
|
|
|
### Main Branches
|
|
- `main` - Production-ready code
|
|
- `develop` - Integration branch for features
|
|
- `feature/*` - Feature branches
|
|
|
|
### Branch Naming
|
|
- `feature/phase-2.8-drug-interactions`
|
|
- `fix/docker-networking`
|
|
- `docs/reorganize-documentation`
|
|
|
|
## 📝 Commit Message Format
|
|
|
|
### Conventional Commits
|
|
```
|
|
<type>(<scope>): <description>
|
|
|
|
[optional body]
|
|
|
|
[optional footer]
|
|
```
|
|
|
|
### Types
|
|
- `feat` - New feature
|
|
- `fix` - Bug fix
|
|
- `docs` - Documentation changes
|
|
- `test` - Test changes
|
|
- `refactor` - Code refactoring
|
|
- `chore` - Maintenance tasks
|
|
|
|
### Examples
|
|
```
|
|
feat(backend): implement drug interaction checking
|
|
fix(medication): resolve adherence calculation bug
|
|
docs(readme): update quick start guide
|
|
test(auth): add refresh token rotation tests
|
|
```
|
|
|
|
## 🚀 Development Workflow
|
|
|
|
### 1. Create Feature Branch
|
|
```bash
|
|
git checkout -b feature/your-feature-name
|
|
```
|
|
|
|
### 2. Make Changes
|
|
```bash
|
|
# Write code
|
|
cargo test
|
|
cargo clippy
|
|
```
|
|
|
|
### 3. Commit Changes
|
|
```bash
|
|
git add .
|
|
git commit -m "feat(scope): description"
|
|
```
|
|
|
|
### 4. Push and Create PR
|
|
```bash
|
|
git push origin feature/your-feature-name
|
|
# Create PR in Forgejo
|
|
```
|
|
|
|
### 5. Merge and Cleanup
|
|
```bash
|
|
git checkout develop
|
|
git pull
|
|
git branch -d feature/your-feature-name
|
|
```
|
|
|
|
## 🛠️ Development Tools
|
|
|
|
### Backend (Rust)
|
|
- **Build**: `cargo build`
|
|
- **Test**: `cargo test`
|
|
- **Lint**: `cargo clippy`
|
|
- **Format**: `cargo fmt`
|
|
- **Run**: `cargo run`
|
|
|
|
### Frontend (React)
|
|
- **Install**: `npm install`
|
|
- **Start**: `npm start`
|
|
- **Build**: `npm run build`
|
|
- **Test**: `npm test`
|
|
|
|
### Docker
|
|
- **Build**: `docker compose build`
|
|
- **Up**: `docker compose up -d`
|
|
- **Down**: `docker compose down`
|
|
- **Logs**: `docker compose logs -f`
|
|
|
|
## 📋 Code Review Checklist
|
|
|
|
### Before Committing
|
|
- [ ] Code compiles without errors
|
|
- [ ] All tests pass
|
|
- [ ] No clippy warnings
|
|
- [ ] Code is formatted
|
|
- [ ] Commit message follows conventions
|
|
- [ ] Documentation updated if needed
|
|
|
|
### Before PR
|
|
- [ ] All checks pass
|
|
- [ ] No merge conflicts
|
|
- [ ] Description explains changes
|
|
- [ ] Tests added/updated
|
|
- [ ] Ready for review
|
|
|
|
---
|
|
|
|
*Last Updated: 2026-06-27*
|