ef58c77d9c
Some checks failed
Lint, Build, and Docker / Check Code Formatting (push) Failing after 42s
Lint, Build, and Docker / Run Clippy Linter (push) Failing after 2s
Lint, Build, and Docker / Build Rust Binary (push) Has been skipped
Lint, Build, and Docker / Build Docker Image (push) Has been skipped
Lint, Build, and Docker / CI Summary (push) Failing after 1s
- Add cargo fmt --check to enforce code formatting
- Add pull_request trigger for PR validation
- Split workflow into parallel jobs (format, clippy, build, docker)
- Integrate Docker Buildx with DinD service
- Add BuildKit caching for faster builds
- Add local test script (scripts/test-ci-locally.sh)
- Add comprehensive documentation
All local CI checks pass ✅
|
||
|---|---|---|
| .. | ||
| CI-IMPROVEMENTS.md | ||
| CI-QUICK-REFERENCE.md | ||
| COMMIT-INSTRUCTIONS.txt | ||
| COMMIT-NOW.sh | ||
| commit_message.txt | ||
| FORGEJO-CI-CD-PIPELINE.md | ||
| FORGEJO-RUNNER-UPDATE.md | ||
| GIT-COMMAND.txt | ||
| GIT-LOG.md | ||
| GIT-STATUS.md | ||
| GIT-STATUS.txt | ||
| README.md | ||
Development Documentation
This section contains development workflow documentation, Git guidelines, and CI/CD configuration.
📚 Workflow Documentation
Git Workflow
- GIT-STATUS.md - Git workflow reference
- GIT-LOG.md - Git log history
- GIT-COMMAND.txt - Useful Git commands
- GIT-STATUS.txt - Git status reference
Commit Guidelines
- COMMIT-INSTRUCTIONS.txt - Commit message guidelines
- commit_message.txt - Commit message template
- COMMIT-NOW.sh - Quick commit script
🔄 CI/CD
Forgejo Configuration
- FORGEJO-CI-CD-PIPELINE.md - CI/CD pipeline documentation
- FORGEJO-RUNNER-UPDATE.md - Runner update notes
🌳 Branch Strategy
Main Branches
main- Production-ready codedevelop- Integration branch for featuresfeature/*- Feature branches
Branch Naming
feature/phase-2.8-drug-interactionsfix/docker-networkingdocs/reorganize-documentation
📝 Commit Message Format
Conventional Commits
<type>(<scope>): <description>
[optional body]
[optional footer]
Types
feat- New featurefix- Bug fixdocs- Documentation changestest- Test changesrefactor- Code refactoringchore- 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
git checkout -b feature/your-feature-name
2. Make Changes
# Write code
cargo test
cargo clippy
3. Commit Changes
git add .
git commit -m "feat(scope): description"
Or use the quick commit script:
./docs/development/COMMIT-NOW.sh
4. Push and Create PR
git push origin feature/your-feature-name
# Create PR in Forgejo
5. Merge and Cleanup
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-03-09