Initial commit: add .gitignore and README
This commit is contained in:
49
.gitignore
vendored
Normal file
49
.gitignore
vendored
Normal file
@@ -0,0 +1,49 @@
|
||||
# Dependencies
|
||||
node_modules/
|
||||
.pnpm-store/
|
||||
vendor/
|
||||
|
||||
# Package manager lock files (optional: uncomment to ignore)
|
||||
# package-lock.json
|
||||
# yarn.lock
|
||||
|
||||
# Environment and secrets
|
||||
.env
|
||||
.env.local
|
||||
.env.*.local
|
||||
*.env.backup
|
||||
.env.backup.*
|
||||
|
||||
# Logs and temp
|
||||
*.log
|
||||
logs/
|
||||
*.tmp
|
||||
*.temp
|
||||
*.tmp.*
|
||||
|
||||
# OS
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
# IDE
|
||||
.vscode/
|
||||
.idea/
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
|
||||
# Build / output
|
||||
dist/
|
||||
build/
|
||||
.next/
|
||||
out/
|
||||
*.pyc
|
||||
__pycache__/
|
||||
.eggs/
|
||||
*.egg-info/
|
||||
.coverage
|
||||
htmlcov/
|
||||
|
||||
# Optional
|
||||
.reports/
|
||||
reports/
|
||||
7
README.md
Normal file
7
README.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# examples
|
||||
|
||||
Project under `/home/intlc/projects/examples`.
|
||||
|
||||
## Overview
|
||||
|
||||
(Add project description and setup instructions here.)
|
||||
162
governance/EXAMPLE_PROPOSAL_MINOR_FEATURE.md
Normal file
162
governance/EXAMPLE_PROPOSAL_MINOR_FEATURE.md
Normal file
@@ -0,0 +1,162 @@
|
||||
# Example Proposal: Minor Feature Addition
|
||||
|
||||
**Note**: This is an EXAMPLE proposal for reference. It demonstrates a proposal for a non-breaking feature addition that requires formal proposal due to cross-system impact.
|
||||
|
||||
---
|
||||
|
||||
# Tier-1 Canonical System Change Proposal
|
||||
|
||||
**Proposal ID**: PROPOSAL-2025-0201-001
|
||||
**Date**: 2025-02-01
|
||||
**Proposer**: DBIS Development Team
|
||||
**System Affected**: DBIS
|
||||
**Type**: Functional
|
||||
|
||||
---
|
||||
|
||||
## 1. Executive Summary
|
||||
|
||||
This proposal adds a new API endpoint to DBIS for retrieving enhanced account information. While non-breaking, this change requires formal proposal due to potential cross-system integration by ICCC and SMOM/SMOA systems.
|
||||
|
||||
---
|
||||
|
||||
## 2. Rationale and Justification
|
||||
|
||||
### Problem Statement
|
||||
ICCC and SMOM/SMOA systems require enhanced account information that is currently not available through existing DBIS APIs. This limits cross-system integration capabilities.
|
||||
|
||||
### Proposed Solution
|
||||
Add new `/api/v1/accounts/{id}/enhanced` endpoint that returns extended account metadata including compliance status, risk tier, and jurisdictional information.
|
||||
|
||||
### Alignment with Constitutional Principles
|
||||
- Maintains DBIS responsibility for account information (Section II.A)
|
||||
- Supports cross-system coordination (SMOM/SMOA responsibility, Section II.C)
|
||||
- No impact on mutual recognition framework
|
||||
- Preserves system boundaries
|
||||
|
||||
---
|
||||
|
||||
## 3. Impact Assessment
|
||||
|
||||
### Affected Systems
|
||||
- [x] DBIS (implementation)
|
||||
- [x] ICCC (potential integration)
|
||||
- [x] SMOM/SMOA (potential integration)
|
||||
- [ ] GRU
|
||||
|
||||
### Scope of Change
|
||||
- **Repository**: `dbis_core`
|
||||
- **Components**: Account service, API gateway
|
||||
- **Interfaces**: New REST API endpoint
|
||||
- **Documentation**: API documentation, integration guides
|
||||
|
||||
### Breaking Changes
|
||||
- [x] No breaking changes
|
||||
- [ ] Breaking changes present
|
||||
|
||||
This is a non-breaking addition. Existing endpoints remain unchanged.
|
||||
|
||||
---
|
||||
|
||||
## 4. Recognition Requirements
|
||||
|
||||
- [ ] **DBIS** - Recognition status: Pending
|
||||
- [ ] **ICCC** - Recognition status: Pending
|
||||
- [ ] **SMOM/SMOA** - Recognition status: Pending
|
||||
|
||||
---
|
||||
|
||||
## 5. Implementation Plan
|
||||
|
||||
### Phases
|
||||
1. **Phase 1**: API endpoint implementation (Week 1-2)
|
||||
2. **Phase 2**: Documentation and testing (Week 2-3)
|
||||
3. **Phase 3**: Deployment and integration support (Week 3-4)
|
||||
|
||||
### Timeline
|
||||
- **Proposal Submission**: 2025-02-01
|
||||
- **Review Period**: 2025-02-01 to 2025-02-15
|
||||
- **Recognition Target**: 2025-02-15
|
||||
- **Implementation Start**: 2025-02-16
|
||||
- **Completion Target**: 2025-03-15
|
||||
|
||||
### Resources Required
|
||||
- 1 backend developer (2 weeks)
|
||||
- 1 API documentation writer (1 week)
|
||||
- Testing resources (1 week)
|
||||
|
||||
---
|
||||
|
||||
## 6. Risk Assessment
|
||||
|
||||
### Technical Risks
|
||||
- **Low Risk**: Addition only, no modification to existing functionality
|
||||
- **Mitigation**: Comprehensive testing, backward compatibility maintained
|
||||
|
||||
### Governance Risks
|
||||
- **Low Risk**: No impact on constitutional principles
|
||||
- **Mitigation**: Maintains system boundaries, supports cross-system coordination
|
||||
|
||||
---
|
||||
|
||||
## 7. Testing and Validation
|
||||
|
||||
### Testing Strategy
|
||||
- Unit tests for new endpoint
|
||||
- Integration tests with existing systems
|
||||
- API documentation examples
|
||||
|
||||
### Validation Criteria
|
||||
- Endpoint returns expected data format
|
||||
- No impact on existing endpoints
|
||||
- Documentation complete
|
||||
- Integration examples provided
|
||||
|
||||
### Rollback Plan
|
||||
- Simple endpoint removal if issues arise
|
||||
- No impact on existing functionality
|
||||
|
||||
---
|
||||
|
||||
## 8. Documentation Updates
|
||||
|
||||
### Required Documentation Changes
|
||||
- [x] API documentation: Add endpoint documentation
|
||||
- [x] Integration guide: Add integration examples
|
||||
- [ ] CANONICAL_CONSTITUTION.md: No changes required
|
||||
- [ ] NOTICE.md files: No changes required
|
||||
|
||||
---
|
||||
|
||||
## 9. Constitutional Compliance Checklist
|
||||
|
||||
- [x] Does not unilaterally supersede another canonical system
|
||||
- [x] Maintains mutual recognition framework
|
||||
- [x] Preserves continuity principles
|
||||
- [x] Respects Tier-1 system boundaries
|
||||
- [x] Aligns with Section IV governance principles
|
||||
- [x] Documentation is inspection-safe
|
||||
|
||||
---
|
||||
|
||||
## 10. Approval and Recognition Log
|
||||
|
||||
| System | Status | Recognized By | Date | Notes |
|
||||
|--------|--------|---------------|------|-------|
|
||||
| DBIS | Pending | - | - | - |
|
||||
| ICCC | Pending | - | - | - |
|
||||
| SMOM/SMOA | Pending | - | - | - |
|
||||
|
||||
**Final Status**: Under Review
|
||||
**Constitutional Amendment Required**: No
|
||||
**Version Increment**: N/A
|
||||
|
||||
---
|
||||
|
||||
## 11. Additional Notes
|
||||
|
||||
This is a straightforward addition that enhances cross-system integration capabilities without impacting existing functionality or constitutional principles.
|
||||
|
||||
---
|
||||
|
||||
**Example Only** - This is a reference example, not an actual proposal.
|
||||
Reference in New Issue
Block a user