From ea13b3753adb94e022a0aa1f57f793d097d64c18 Mon Sep 17 00:00:00 2001 From: Sami Assiri Date: Thu, 16 Apr 2026 07:08:44 +0300 Subject: [PATCH] docs/ci: implement GitHub Delivery Pack governance templates (PR, Issues, ADR) --- .../ISSUE_TEMPLATE/agent_feature_request.md | 37 +++++++++++++++++ .../governance_policy_update.md | 32 +++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 36 +++++++++++++++++ docs/adr/0000-adr-template.md | 40 +++++++++++++++++++ 4 files changed, 145 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/agent_feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/governance_policy_update.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 docs/adr/0000-adr-template.md diff --git a/.github/ISSUE_TEMPLATE/agent_feature_request.md b/.github/ISSUE_TEMPLATE/agent_feature_request.md new file mode 100644 index 00000000..0f78b900 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/agent_feature_request.md @@ -0,0 +1,37 @@ +--- +name: Agent Feature / Logic Request +about: اقتراح وكيل جديد أو تعديل منطق وكيل حالي (Agent Logic Update) +title: '[Agent] ' +labels: 'agent-logic, enhancement' +assignees: '' + +--- + +### هدف الوكيل (Agent Objective) +*ما هي الغاية من هذه الإضافة أو التغيير؟* + + +### العائلة الاستراتيجية (Strategic Family) +- [ ] Opportunity & Growth Intelligence +- [ ] Corporate Development & M&A +- [ ] Revenue & Commercial Operations +- [ ] Governance, Execution, and Learning + +### المدخلات والأدوات (Inputs & Tools Required) +*ما هي مصادر البيانات التي سيقرأ منها الوكيل؟ وما هي تقنيات الـ API أو الـ Tools التي سيحتاجها؟* + + +### هيكل الـ Decision Memo (The Uniform Output) +*انسخ هنا الـ JSON Schema المتوقعة للقرار أو الإجراء.* +```json + +``` + +### الأحداث (Event In & Event Out) +*ما هو الحدث الذي يشغّل هذا الوكيل؟ وما هي الأحداث التي ينتجها؟* +- Event In: +- Events Out: + +### مصفوفة الحوكمة والمخاطر (Governance & HITL) +*متى يجب أن يتوقف هذا الوكيل ويطلب موافقة بشرية (HITL)؟* + diff --git a/.github/ISSUE_TEMPLATE/governance_policy_update.md b/.github/ISSUE_TEMPLATE/governance_policy_update.md new file mode 100644 index 00000000..02c86f38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/governance_policy_update.md @@ -0,0 +1,32 @@ +--- +name: Governance Policy Update +about: إضافة أو تعديل سياسات الحوكمة والموافقات وصلاحيات النظام +title: '[Policy] ' +labels: 'governance, security, pdpl' +assignees: '' + +--- + +### وصف السياسة (Policy Description) +*ما هو الغرض من هذه السياسة؟ (مثال: منع إصدار عرض مالي فوق X بمجرد اعتماد آلي).* + + +### الوكلاء المتأثرون (Affected Agents) +*قائمة بالوكلاء الذين يجب تعديل الـ System Prompts الخاصة بهم أو توجيهات الـ Policy Engine لمنع تجاوزهم هذه القاعدة.* + + +### شروط التطبيق (Trigger Conditions Code) +*كيف يمكن كتابة هذه السياسة برمجياً داخل محرك السياسات (Policy-As-Code)؟* + + +### مستوى التصعيد (Escalation Path) +*حال كسر هذه القاعدة من النظام، من هي الجهة أو المُسمى الوظيفي الذي يتم التصعيد إليه فوراً؟* + +- [ ] CEO +- [ ] VP Strategy / M&A Director +- [ ] VP Sales / Partnerships +- [ ] Legal / Compliance Officer + +### خطة التراجع والمخاطر (Rollback & Risk) +*ما هي المخاطرة من تطبيق هذا القيد (عنق زجاجة مثلاً)؟ وكيف يمكن إيقافه إذا تسبب بشلل في النظام؟* + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..0af4d8e5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,36 @@ +## PR Title: [Agent/Feature/Fix] Brief Description + +### 1. Business Context & Objective +*لماذا نحتاج هذا التغيير؟ وكيف سيساهم في نمو الإيرادات أو الاستراتيجية (Sovereign OS)؟* +- + +### 2. Linked Initiative / Issues +*أرقام مهام GitHub المرتبطة (Issues)، أو اسم المبادرة في الـ PMO Agent.* +- Closes # + +### 3. User & Business Impact +*النتائج المتوقعة من هذا التغيير على المستوى التجاري (أرقام، أداء، أرباح).* +- + +### 4. Technical Architecture & State Impact +*هل يغير هذا الـ PR في (Event Schema, State Machine, Policy Engine)؟ اذكر التفاصيل.* +- + +### 5. Risk Level & Governance (مهم جداً) +*اختر مستوى المخاطرة:* +- [ ] 🔴 **High Risk**: (M&A, المالية, صلاحيات الـ Board) - يتطلب مراجعتين وموافقة. +- [ ] 🟡 **Medium Risk**: (شراكات، نماذج هوامش الربح، أتمتة مبيعات عالية). +- [ ] 🟢 **Low Risk**: (تحديثات واجهة، تقارير داخلية غير مالية). + +### 6. Data Privacy & Compliance (PDPL) +- [ ] لا يوجد خطر أو معالجة لبيانات حساسة. +- [ ] تم التحقق من الامتثال لسياسات حفظ ومشاركة البيانات (Data Privacy Policy). + +### 7. Rollback Plan +*كيف يمكن التراجع عن هذا التعديل في حال فشله في بيئة الإنتاج מבون التأثير على العقود أو الشركاء؟* +- + +### 8. QA & Observability Updates +*كيف سيتم تتبع نجاح هذا التحديث؟ هل تم إضافة Logging/Events للوحات الـ Sovereign Dashboard؟* +- [ ] تم إضافة/تحديث الـ Unit/Integration Tests. +- [ ] تم التحديث في مصفوفة الـ Execution Matrix إذا استدعى الأمر. diff --git a/docs/adr/0000-adr-template.md b/docs/adr/0000-adr-template.md new file mode 100644 index 00000000..444fe96e --- /dev/null +++ b/docs/adr/0000-adr-template.md @@ -0,0 +1,40 @@ +# ADR [0000]: [العنوان التنفيذي المعماري - Architecture Decision Record Title] + +**تاريخ الاعتماد (Date):** [YYYY-MM-DD] +**مستوى الأثر (Impact):** [High / Medium / Low] +**الحالة (Status):** [Proposed / Accepted / Rejected / Deprecated / Superseded] + +--- + +## 1. السياق والمشكلة (Context & Problem Statement) +*ما هي التحديات التقنية أو الاستراتيجية في Sovereign OS التي فرضت التفكير في هذا القرار؟ (مثلاً: تعارض بين ردود الوكيل המالي ووكيل الامتثال، أو حاجة لتخزين وثائق الـ VDR بحجم كبير).* + +## 2. محركات القرار (Decision Drivers) +*ما هي المعايير التي حكمت هذا القرار؟ (مثال: أمان البيانات PDPL، سرعة الأداء، قابلية توسع عدد الوكلاء).* +- +- +- + +## 3. الخيارات قيد النظر (Considered Options) +*ما هي البدائل التقنية أو المعمارية التي تم طرحها على الطاولة؟* +1. **[الخيار الأول]**: +2. **[الخيار الثاني]**: +3. **[الخيار الثالث]**: + +## 4. القرار النهائي (Decision Outcome) +*وقع الاختيار على [الخيار الفلاني] لأنه يحقق...* + +### النتيجة الإيجابية (Positive Consequences) +- +- + +### النتيجة السلبية و الخسارة المترتبة (Negative Consequences / Trade-offs) +- +- + +## 5. خطة التكامل المعماري (Integration Plan) +*كيف سيتم تطبيق هذا القرار على الـ 8 طبقات؟ وهل سيتطلب تحديث `Event Schema` أو `Policy Engine`؟* + +## 6. مراجع ومقروءات ملحقة (Links / References) +- [Link to Strategy Doc] +- [Link to GitHub Issue/PR]