contextcompass 2.15.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- contextcompass-2.15.0.dist-info/METADATA +673 -0
- contextcompass-2.15.0.dist-info/RECORD +452 -0
- contextcompass-2.15.0.dist-info/WHEEL +4 -0
- contextcompass-2.15.0.dist-info/entry_points.txt +2 -0
- contextcompass-2.15.0.dist-info/licenses/LICENSE +21 -0
- contextcompass_cli/__init__.py +74 -0
- contextcompass_cli/__main__.py +195 -0
- contextcompass_cli/_package/AGENTS.MD +310 -0
- contextcompass_cli/_package/CONTEXT_COMPACTION.md +110 -0
- contextcompass_cli/_package/MANIFEST.md +485 -0
- contextcompass_cli/_package/PROFILE_CLASS_CREATION_GUIDE.md +426 -0
- contextcompass_cli/_package/README.md +266 -0
- contextcompass_cli/_package/SKILLS.MD +144 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/AGENTS.MD +54 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/README.md +43 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/behavioral_guidelines/continuity_fact_checker_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/examples/continuity_fact_checker_task_flow.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/policies/continuity_fact_checker_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/policies/continuity_fact_checker_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/skills/continuity_fact_checker.md +37 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/skills/continuity_fact_checker_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/skills/continuity_fact_checker_deliverables.md +26 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/skills/continuity_fact_checker_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/AGENTS.MD +85 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/README.md +62 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/SKILLS.MD +74 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/behavioral_guidelines/design_engineer_workflow.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/behavioral_guidelines/design_validation_and_handoff.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/examples/adr_example.md +40 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/examples/design_task_flow.md +33 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/policies/decision_record_policy.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/policies/design_quality_policy.md +30 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/policies/design_review_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/policies/system_document_quality_rubric.md +236 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/adr_and_decision_hygiene.md +38 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/api_and_interface_design.md +36 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/architecture_contexts.md +40 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/architecture_patch_contracts.md +43 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/architecture_tradeoffs.md +33 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/code_description_patch_contracts.md +46 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/component_patch_contracts.md +41 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/data_modeling.md +34 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/decomposition_and_boundaries.md +42 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/design_engineer_execution.md +65 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/design_review_protocol.md +34 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/nonfunctional_requirements.md +34 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/patch_framework_design.md +79 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/requirements_to_architecture.md +39 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/src_architecture_instructions.md +347 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/src_components_instructions.md +405 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/system_design_method.md +45 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/tests_architecture_instructions.md +375 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/tests_components_instructions.md +406 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/AGENTS.MD +53 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/README.md +42 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/behavioral_guidelines/developmental_editor_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/examples/developmental_editor_task_flow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/policies/developmental_editor_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/policies/developmental_editor_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/skills/developmental_editor.md +36 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/skills/developmental_editor_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/skills/developmental_editor_deliverables.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/skills/developmental_editor_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/AGENTS.MD +54 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/README.md +43 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/behavioral_guidelines/draft_writer_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/examples/draft_writer_task_flow.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/policies/draft_writer_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/policies/draft_writer_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/skills/draft_writer.md +37 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/skills/draft_writer_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/skills/draft_writer_deliverables.md +26 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/skills/draft_writer_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/AGENTS.MD +493 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/README.md +53 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/SKILLS.MD +263 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/behavioral_guidelines/engineer_workflow.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/behavioral_guidelines/task_execution_and_validation.md +34 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/examples/artifact_workflow.md +104 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/examples/eng_task_flow.md +30 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/policies/ctx_autonomy_policy.md +34 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/policies/ctx_autonomy_rubric.md +161 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/policies/engineer_quality_policy.md +33 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/context_protocol.md +70 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/documentation_standards.md +120 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/engineer_execution.md +62 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/package_maintenance.md +195 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/patch_artifact_consumption.md +68 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/patch_framework_gating.md +72 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/src_graph_generation.md +341 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/src_graph_usage.md +161 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/staleness_protocol.md +49 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/system_document_build.md +360 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/system_orientation.md +83 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/technical_expertise.md +48 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/workflows/README.md +9 -0
- contextcompass_cli/_package/agent_onboarding/default/general/AGENTS.MD +283 -0
- contextcompass_cli/_package/agent_onboarding/default/general/README.md +38 -0
- contextcompass_cli/_package/agent_onboarding/default/general/SKILLS.MD +92 -0
- contextcompass_cli/_package/agent_onboarding/default/general/WORKFLOWS.MD +23 -0
- contextcompass_cli/_package/agent_onboarding/default/general/behavioral_guidelines/README.md +12 -0
- contextcompass_cli/_package/agent_onboarding/default/general/behavioral_guidelines/agent_lifecycle_and_heartbeat.md +37 -0
- contextcompass_cli/_package/agent_onboarding/default/general/behavioral_guidelines/onboarding_summary.md +41 -0
- contextcompass_cli/_package/agent_onboarding/default/general/behavioral_guidelines/work_intake_and_execution.md +44 -0
- contextcompass_cli/_package/agent_onboarding/default/general/policies/policy_skills.md +174 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/active_documentation.md +86 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/active_pointerboard.md +81 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/agent_identity.md +38 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/agent_lifecycle.md +21 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/agent_stance.md +38 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/career_selection.md +83 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/compaction_requirements.md +147 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/configuration_standards.md +72 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/context_compaction.md +104 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/context_gold.md +31 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/context_management.md +79 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/context_window_budget.md +64 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/execution_contract.md +234 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/general.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/llm_full_usage.md +111 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/mailbox_protocol.md +85 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/memory_management.md +28 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/mrp_policy.md +40 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/package_upgrade.md +135 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/reactive_documentation.md +105 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/repo_topology.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/role_local_workflows.md +41 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/security_and_secrets.md +46 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/self_certification.md +49 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/ticket_closure_attention_sync.md +57 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/ticket_microcycle.md +44 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/ticketing.md +175 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/ticketing_skill_contract.md +52 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/unknowns_gate_reference.md +66 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/user_approved_certification.md +32 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/workflow.md +289 -0
- contextcompass_cli/_package/agent_onboarding/default/general/workflows/README.md +9 -0
- contextcompass_cli/_package/agent_onboarding/default/general/workflows/cleanup_context_compass.md +205 -0
- contextcompass_cli/_package/agent_onboarding/default/general/workflows/role_creation.md +39 -0
- contextcompass_cli/_package/agent_onboarding/default/general/workflows/start_context_compass_work.md +102 -0
- contextcompass_cli/_package/agent_onboarding/default/general/workflows/sync_attention_board.md +91 -0
- contextcompass_cli/_package/agent_onboarding/default/general/workflows/turn_in_selected_tickets.md +95 -0
- contextcompass_cli/_package/agent_onboarding/default/general/workflows/workflow_creation.md +38 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/AGENTS.MD +53 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/README.md +42 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/behavioral_guidelines/line_copy_editor_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/examples/line_copy_editor_task_flow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/policies/line_copy_editor_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/policies/line_copy_editor_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/skills/line_copy_editor.md +36 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/skills/line_copy_editor_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/skills/line_copy_editor_deliverables.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/skills/line_copy_editor_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/new/AGENTS.MD +79 -0
- contextcompass_cli/_package/agent_onboarding/default/new/README.md +54 -0
- contextcompass_cli/_package/agent_onboarding/default/new/SKILLS.MD +35 -0
- contextcompass_cli/_package/agent_onboarding/default/new/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/new/behavioral_guidelines/user_onboarding_flow.md +52 -0
- contextcompass_cli/_package/agent_onboarding/default/new/policies/new_onboarding_policy.md +59 -0
- contextcompass_cli/_package/agent_onboarding/default/new/skills/configuration_map_guide.md +83 -0
- contextcompass_cli/_package/agent_onboarding/default/new/skills/first_time_profile_setup.md +60 -0
- contextcompass_cli/_package/agent_onboarding/default/new/skills/new.md +54 -0
- contextcompass_cli/_package/agent_onboarding/default/new/skills/onboarding_completion_and_next_step.md +54 -0
- contextcompass_cli/_package/agent_onboarding/default/new/skills/profile_model_explained.md +120 -0
- contextcompass_cli/_package/agent_onboarding/default/new/skills/system_overview_for_user.md +51 -0
- contextcompass_cli/_package/agent_onboarding/default/new/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/AGENTS.MD +63 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/README.md +41 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/SKILLS.MD +62 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/behavioral_guidelines/incident_workflow.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/behavioral_guidelines/platform_engineer_workflow.md +18 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/examples/platform_task_flow.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/policies/operational_safety_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/policies/platform_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/policies/production_change_management_policy.md +18 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/ci_cd_and_release.md +28 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/deployment_and_environments.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/incident_response_and_runbooks.md +35 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/infrastructure_as_code.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/observability_and_monitoring.md +28 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/performance_capacity_cost.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/platform_engineer_execution.md +41 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/platform_security_basics.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/AGENTS.MD +53 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/README.md +42 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/behavioral_guidelines/proofreader_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/examples/proofreader_task_flow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/policies/proofreader_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/policies/proofreader_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/skills/proofreader.md +36 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/skills/proofreader_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/skills/proofreader_deliverables.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/skills/proofreader_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/AGENTS.MD +58 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/README.md +41 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/SKILLS.MD +61 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/behavioral_guidelines/qa_workflow.md +18 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/behavioral_guidelines/release_signoff_workflow.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/examples/qa_task_flow.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/policies/defect_severity_policy.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/policies/quality_gate_policy.md +18 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/policies/test_evidence_policy.md +18 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/bug_triage_and_repro.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/qa_engineer_execution.md +29 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/quality_metrics.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/regression_and_release_quality.md +28 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/test_automation_practices.md +30 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/test_case_design.md +27 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/test_data_and_environments.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/test_strategy_and_planning.md +31 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/AGENTS.MD +55 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/README.md +44 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/behavioral_guidelines/researcher_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/examples/researcher_task_flow.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/policies/researcher_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/policies/researcher_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/skills/researcher.md +38 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/skills/researcher_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/skills/researcher_deliverables.md +27 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/skills/researcher_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/AGENTS.MD +55 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/README.md +43 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/SKILLS.MD +62 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/behavioral_guidelines/security_signoff_and_escalation.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/behavioral_guidelines/security_workflow.md +18 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/examples/security_review_flow.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/policies/risk_acceptance_policy.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/policies/secrets_and_keys_policy.md +19 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/policies/security_review_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/authn_authz_basics.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/dependency_and_supply_chain.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/incident_response_security.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/logging_audit_privacy.md +16 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/secure_architecture_review.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/secure_coding_review.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/security_engineer_execution.md +28 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/threat_modeling.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/vulnerability_management.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/AGENTS.MD +56 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/README.md +45 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/behavioral_guidelines/story_designer_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/examples/story_designer_task_flow.md +26 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/policies/story_designer_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/policies/story_designer_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/skills/story_designer.md +39 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/skills/story_designer_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/skills/story_designer_deliverables.md +28 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/skills/story_designer_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/AGENTS.MD +56 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/README.md +45 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/behavioral_guidelines/story_novel_artist_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/examples/story_novel_artist_task_flow.md +26 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/policies/story_novel_artist_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/policies/story_novel_artist_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/skills/story_novel_artist.md +39 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/skills/story_novel_artist_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/skills/story_novel_artist_deliverables.md +28 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/skills/story_novel_artist_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/AGENTS.MD +66 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/SKILLS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/behavioral_guidelines/data_engineer_behavior_overrides.md +6 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/policies/data_engineer_policy_overrides.md +6 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/profile_overrides.md +9 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/skills/data_engineer_skill_overrides.md +6 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/AGENTS.MD +145 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/SKILLS.MD +37 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/WORKFLOWS.MD +17 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/behavioral_guidelines/synaptic_finishing_developer_behavior_overrides.md +12 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/examples/python/comment_finishing_examples.py +65 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/examples/python/docstring_finishing_examples.py +126 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/examples/python/pytest_component_finishing_examples.py +51 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/examples/python/pytest_integration_finishing_examples.py +59 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/examples/python/pytest_unit_finishing_examples.py +66 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/policies/synaptic_finishing_developer_policy_overrides.md +14 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/profile_overrides.md +17 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/documentation/comment_craft.md +51 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/documentation/docstring_craft.md +86 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/documentation/docstring_test_alignment.md +51 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/documentation/system_aware_docstrings.md +64 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/synaptic_finishing_developer_skill_overrides.md +11 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/testing/component_tests.md +45 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/testing/evidence_reporting.md +25 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/testing/mocking.md +35 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/testing/pytest_integration.md +32 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/testing/pytest_unit.md +49 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/testing/regression_tests.md +24 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/testing/testing_overview.md +71 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/workflows/optimize_pytests_for_repo.md +272 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/workflows/polish_repo_documentation.md +247 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/AGENTS.MD +386 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/README.md +31 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/WORKFLOWS.MD +16 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/behavioral_guidelines/synaptic_behavior_overrides.md +17 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/anti_patterns.py +19 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/cleanup_patterns.py +22 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/docstrings.py +19 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/logging_patterns.py +11 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/protocols_and_abc.py +15 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/pytest_component_examples.py +15 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/pytest_integration_examples.py +17 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/pytest_unit_examples.py +13 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/policies/synaptic_policy_overrides.md +22 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/profile_overrides.md +27 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/attribute_aliasing_skill_benchmark.py +35 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/banned_patterns.md +110 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/cleanup_and_disposal.md +79 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/comments.md +39 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/docstrings.md +90 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/error_model.md +28 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/hot_path_attribute_aliasing.md +52 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/init_and_ownership.md +35 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/interfaces.md +47 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/logging.md +37 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/module_scope.md +38 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/refactor_limits.md +44 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/typing.md +52 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/synaptic_skill_overrides.md +24 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/testing/evidence_reporting.md +35 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/testing/mocking.md +31 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/testing/pytest_integration.md +36 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/testing/pytest_unit.md +42 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/testing/regression_tests.md +26 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/testing/testing_overview.md +196 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/workflows/synaptic_python_developer_onboarding.md +226 -0
- contextcompass_cli/_package/artifact_board.md +64 -0
- contextcompass_cli/_package/artifacts/IMPORTANT_CONSIDERATION.md +43 -0
- contextcompass_cli/_package/artifacts/README.md +41 -0
- contextcompass_cli/_package/attention_board.md +79 -0
- contextcompass_cli/_package/config/context_compass_config.yaml +101 -0
- contextcompass_cli/_package/context_management/README.md +21 -0
- contextcompass_cli/_package/context_management/artifacts/.gitkeep +1 -0
- contextcompass_cli/_package/context_management/context_artifact_template.md +42 -0
- contextcompass_cli/_package/context_management/context_board.md +27 -0
- contextcompass_cli/_package/examples/adr_example.md +29 -0
- contextcompass_cli/_package/examples/artifact_workflow.md +20 -0
- contextcompass_cli/_package/examples/continuity_fact_checker_task_flow.md +23 -0
- contextcompass_cli/_package/examples/design_task_flow.md +35 -0
- contextcompass_cli/_package/examples/developmental_editor_task_flow.md +22 -0
- contextcompass_cli/_package/examples/draft_writer_task_flow.md +23 -0
- contextcompass_cli/_package/examples/eng_task_flow.md +31 -0
- contextcompass_cli/_package/examples/example_architecture/.gitkeep +0 -0
- contextcompass_cli/_package/examples/example_architecture/src_architecture.md +136 -0
- contextcompass_cli/_package/examples/example_architecture/src_architecture_index.md +46 -0
- contextcompass_cli/_package/examples/example_architecture/tests_architecture.md +148 -0
- contextcompass_cli/_package/examples/example_architecture/tests_architecture_index.md +46 -0
- contextcompass_cli/_package/examples/example_completed/.gitkeep +0 -0
- contextcompass_cli/_package/examples/example_completed/2026-02-19_context_compass_release_overview_artifact.md +33 -0
- contextcompass_cli/_package/examples/example_components/.gitkeep +0 -0
- contextcompass_cli/_package/examples/example_components/src_components.md +169 -0
- contextcompass_cli/_package/examples/example_components/src_components_index.md +44 -0
- contextcompass_cli/_package/examples/example_components/tests_components.md +96 -0
- contextcompass_cli/_package/examples/example_components/tests_components_index.md +42 -0
- contextcompass_cli/_package/examples/example_epics/.gitkeep +0 -0
- contextcompass_cli/_package/examples/example_epics/2026-02-19_context_compass_release_readiness_example_pack_epic.md +130 -0
- contextcompass_cli/_package/examples/example_graph_details/README.md +131 -0
- contextcompass_cli/_package/examples/example_graph_details/src/example/__init__.py +4 -0
- contextcompass_cli/_package/examples/example_graph_details/src/example/core/interfaces.py +10 -0
- contextcompass_cli/_package/examples/example_graph_details/src/example/core/resource.py +15 -0
- contextcompass_cli/_package/examples/example_graph_details/src/example/pipeline/pipeline.py +20 -0
- contextcompass_cli/_package/examples/example_graph_details/src/example/pipeline/stage.py +11 -0
- contextcompass_cli/_package/examples/example_graph_details/src/example/storage/store.py +20 -0
- contextcompass_cli/_package/examples/example_graph_details/src_graph.md +192 -0
- contextcompass_cli/_package/examples/example_graph_details/src_graph_index.md +32 -0
- contextcompass_cli/_package/examples/example_stories/.gitkeep +0 -0
- contextcompass_cli/_package/examples/example_stories/2026-02-19_context_compass_release_readiness_examples_story.md +120 -0
- contextcompass_cli/_package/examples/example_tasks/.gitkeep +0 -0
- contextcompass_cli/_package/examples/example_tasks/2026-02-19_context_compass_release_readiness_pack_task.md +147 -0
- contextcompass_cli/_package/examples/line_copy_editor_task_flow.md +23 -0
- contextcompass_cli/_package/examples/platform_task_flow.md +26 -0
- contextcompass_cli/_package/examples/proofreader_task_flow.md +23 -0
- contextcompass_cli/_package/examples/qa_task_flow.md +26 -0
- contextcompass_cli/_package/examples/repo_overview.md +63 -0
- contextcompass_cli/_package/examples/researcher_task_flow.md +23 -0
- contextcompass_cli/_package/examples/security_review_flow.md +24 -0
- contextcompass_cli/_package/examples/story_designer_task_flow.md +23 -0
- contextcompass_cli/_package/examples/story_novel_artist_task_flow.md +22 -0
- contextcompass_cli/_package/mailbox_board.md +79 -0
- contextcompass_cli/_package/special_instructions/README.md +16 -0
- contextcompass_cli/_package/system_docs/.gitkeep +0 -0
- contextcompass_cli/_package/system_docs/patches/active/README.md +25 -0
- contextcompass_cli/_package/system_docs/patches/active/_template_patch_id/architecture_patch.md +53 -0
- contextcompass_cli/_package/system_docs/patches/active/_template_patch_id/code_description_patch_TEMPLATE_COMPONENT.md +39 -0
- contextcompass_cli/_package/system_docs/patches/active/_template_patch_id/component_patch_TEMPLATE_COMPONENT.md +48 -0
- contextcompass_cli/_package/system_docs/system_docs_read_first.md +107 -0
- contextcompass_cli/_package/templates/epic_template.md +149 -0
- contextcompass_cli/_package/templates/story_template.md +131 -0
- contextcompass_cli/_package/templates/task_template.md +124 -0
- contextcompass_cli/_package/templates/workflow_advanced_template.md +111 -0
- contextcompass_cli/_package/templates/workflow_simple_template.md +65 -0
- contextcompass_cli/_package/tickets/README.md +24 -0
- contextcompass_cli/_package/tickets/epics/README.md +68 -0
- contextcompass_cli/_package/tickets/epics/archive/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/epics/backlog/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/epics/completed/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/stories/README.md +68 -0
- contextcompass_cli/_package/tickets/stories/archive/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/stories/backlog/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/stories/completed/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/tasks/README.md +67 -0
- contextcompass_cli/_package/tickets/tasks/archive/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/tasks/backlog/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/tasks/completed/.gitkeep +0 -0
- contextcompass_cli/_package/tools/build_llm_full.py +307 -0
- contextcompass_cli/_package/tools/cleanup_context_compass.py +488 -0
- contextcompass_cli/_package/tools/migrate_boards.py +218 -0
- contextcompass_cli/_package/tools/package_manifest.py +351 -0
- contextcompass_cli/_package/tools/system_documents/index_document.py +476 -0
- contextcompass_cli/_package/tools/system_documents/python/assemble_graph.py +387 -0
- contextcompass_cli/_package/tools/system_documents/python/extract_graph.py +626 -0
- contextcompass_cli/_package/tools/system_documents/python/graph_semantics_tickets.py +405 -0
- contextcompass_cli/_package/tools/system_documents/python/graph_walker.py +375 -0
- contextcompass_cli/_package/tools/system_documents/python/migrate_authored_graph.py +179 -0
- contextcompass_cli/_package/tools/update_context_compass.py +511 -0
- contextcompass_cli/_package/user_defined/README.md +49 -0
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
|
|
2
|
+
# Design Engineer Career
|
|
3
|
+
|
|
4
|
+
Purpose
|
|
5
|
+
- Design-engineer-specific onboarding deltas on top of the shared `general` baseline and the `engineer` implementation baseline.
|
|
6
|
+
- Optimized for software/system design, architecture planning, and high-quality handoff to implementation.
|
|
7
|
+
|
|
8
|
+
Scope rule
|
|
9
|
+
- Keep only design-engineer-specific policy/behavior here.
|
|
10
|
+
- Shared rules remain in:
|
|
11
|
+
- `agent_onboarding/default/general/` (process, ticketing, gates, certification)
|
|
12
|
+
- `agent_onboarding/default/engineer/` (implementation and engineering quality discipline)
|
|
13
|
+
- Design Engineer extends `engineer` and must remain a delta layer:
|
|
14
|
+
no path overlap with `agent_onboarding/default/engineer/SKILLS.MD`.
|
|
15
|
+
|
|
16
|
+
Design Engineer inventory
|
|
17
|
+
- `agent_onboarding/default/design_engineer/SKILLS.MD`: design-engineer-specific read sequence.
|
|
18
|
+
- `skills/architecture_contexts.md`: architecture/components source-of-truth policy.
|
|
19
|
+
- `skills/src_architecture_instructions.md`: creation/maintenance mechanics for
|
|
20
|
+
`system_docs/src_architecture.md`.
|
|
21
|
+
- `skills/src_components_instructions.md`: creation/maintenance mechanics for
|
|
22
|
+
`system_docs/src_components.md`.
|
|
23
|
+
- `agent_onboarding/default/engineer/skills/src_graph_usage.md`: how to read
|
|
24
|
+
`system_docs/src_graph_index.md` and slice `system_docs/src_graph.md`.
|
|
25
|
+
Inherited from `engineer`; it does not live in this folder.
|
|
26
|
+
- `agent_onboarding/default/engineer/skills/src_graph_generation.md`: how those
|
|
27
|
+
two files are produced by `tools/system_documents/python/`.
|
|
28
|
+
- `agent_onboarding/default/engineer/skills/system_document_build.md`: authoring
|
|
29
|
+
format and index mechanics for the authored system documents. Inherited from
|
|
30
|
+
`engineer`; it does not live in this folder.
|
|
31
|
+
- `skills/tests_architecture_instructions.md`: creation/maintenance mechanics
|
|
32
|
+
for `system_docs/tests_architecture.md`.
|
|
33
|
+
- `skills/tests_components_instructions.md`: creation/maintenance mechanics for
|
|
34
|
+
`system_docs/tests_components.md`.
|
|
35
|
+
- `skills/design_engineer_execution.md`: design execution discipline and artifact expectations.
|
|
36
|
+
- `skills/requirements_to_architecture.md`: convert goals to requirements, constraints, and acceptance criteria.
|
|
37
|
+
- `skills/system_design_method.md`: system design structure (components, data flows, failure modes).
|
|
38
|
+
- `skills/decomposition_and_boundaries.md`: decomposition, boundaries, and coupling control.
|
|
39
|
+
- `skills/api_and_interface_design.md`: interface/API design discipline (contracts, versioning, errors).
|
|
40
|
+
- `skills/data_modeling.md`: schema and data modeling discipline.
|
|
41
|
+
- `skills/architecture_tradeoffs.md`: tradeoff analysis and option evaluation.
|
|
42
|
+
- `skills/adr_and_decision_hygiene.md`: ADR format, decision recording, and decision hygiene.
|
|
43
|
+
- `skills/nonfunctional_requirements.md`: NFR design (performance, reliability, security, operability).
|
|
44
|
+
- `skills/design_review_protocol.md`: review/checkpoint protocol and handoff to tickets.
|
|
45
|
+
- `policies/design_quality_policy.md`: design artifact quality bar.
|
|
46
|
+
- `policies/decision_record_policy.md`: ADR and decision-record gating.
|
|
47
|
+
- `policies/design_review_policy.md`: review gate rules before implementation.
|
|
48
|
+
- `behavioral_guidelines/design_engineer_workflow.md`: design task execution flow.
|
|
49
|
+
- `behavioral_guidelines/design_validation_and_handoff.md`: validation and implementation handoff flow.
|
|
50
|
+
- `examples/design_task_flow.md`: example design task flow.
|
|
51
|
+
- `examples/adr_example.md`: ADR example template.
|
|
52
|
+
|
|
53
|
+
Overlap rules
|
|
54
|
+
- If a skill is already defined in `engineer` or `general`, reference it instead of duplicating.
|
|
55
|
+
- Implementation tasks still follow engineer execution discipline:
|
|
56
|
+
- `agent_onboarding/default/engineer/skills/engineer_execution.md`
|
|
57
|
+
- `agent_onboarding/default/engineer/behavioral_guidelines/task_execution_and_validation.md`
|
|
58
|
+
|
|
59
|
+
Unknowns Gate
|
|
60
|
+
- Apply the canonical policy in
|
|
61
|
+
`agent_onboarding/default/general/skills/unknowns_gate_reference.md`.
|
|
62
|
+
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
|
|
2
|
+
# SKILLS.MD - design_engineer
|
|
3
|
+
|
|
4
|
+
Purpose
|
|
5
|
+
- Define required baseline design-engineer skills for the `design_engineer` role.
|
|
6
|
+
- This role is optimized for designing software engineering projects with high-quality handoff.
|
|
7
|
+
|
|
8
|
+
Inheritance
|
|
9
|
+
- `INHERITS_SKILLS_FROM: agent_onboarding/default/engineer/SKILLS.MD`
|
|
10
|
+
|
|
11
|
+
Skill classes (non-negotiable)
|
|
12
|
+
- This role ADDS two classes of its own:
|
|
13
|
+
A) **Required baseline skills** (always required for onboarding/certification)
|
|
14
|
+
B) **On-demand design-context skills** (required only when the active task triggers them)
|
|
15
|
+
- It also INHERITS the parent chain's classes, which include `engineer`'s
|
|
16
|
+
**Baseline system orientation** - `system_docs/system_docs_read_first.md`,
|
|
17
|
+
`src_architecture.md`, `src_architecture_index.md`, `src_components_index.md`.
|
|
18
|
+
Those are baseline for this role too. This section describes what this file adds;
|
|
19
|
+
it is not the complete list of what you must read.
|
|
20
|
+
|
|
21
|
+
Rules
|
|
22
|
+
- You MUST read **all** paths listed under **Required baseline skills** for this role
|
|
23
|
+
to be considered onboarded/certifiable as `design_engineer`, **plus** every
|
|
24
|
+
baseline section in the inherited chain.
|
|
25
|
+
- You MUST NOT claim an on-demand skill was read unless:
|
|
26
|
+
1) a trigger condition was met, AND
|
|
27
|
+
2) you actually read it in full.
|
|
28
|
+
- When a trigger condition is met, the on-demand skills become mandatory and MUST be
|
|
29
|
+
read **before** any work in that scope.
|
|
30
|
+
|
|
31
|
+
Required baseline skills
|
|
32
|
+
- `agent_onboarding/default/design_engineer/AGENTS.MD`
|
|
33
|
+
- `agent_onboarding/default/design_engineer/WORKFLOWS.MD`
|
|
34
|
+
- `agent_onboarding/default/design_engineer/skills/architecture_contexts.md`
|
|
35
|
+
- `agent_onboarding/default/design_engineer/skills/patch_framework_design.md`
|
|
36
|
+
- `agent_onboarding/default/design_engineer/skills/architecture_patch_contracts.md`
|
|
37
|
+
- `agent_onboarding/default/design_engineer/skills/component_patch_contracts.md`
|
|
38
|
+
- `agent_onboarding/default/design_engineer/skills/code_description_patch_contracts.md`
|
|
39
|
+
- `agent_onboarding/default/design_engineer/skills/src_architecture_instructions.md`
|
|
40
|
+
- `agent_onboarding/default/design_engineer/skills/src_components_instructions.md`
|
|
41
|
+
- `agent_onboarding/default/design_engineer/skills/tests_architecture_instructions.md`
|
|
42
|
+
- `agent_onboarding/default/design_engineer/skills/tests_components_instructions.md`
|
|
43
|
+
- `agent_onboarding/default/design_engineer/skills/design_engineer_execution.md`
|
|
44
|
+
- `agent_onboarding/default/design_engineer/skills/requirements_to_architecture.md`
|
|
45
|
+
- `agent_onboarding/default/design_engineer/skills/system_design_method.md`
|
|
46
|
+
- `agent_onboarding/default/design_engineer/skills/decomposition_and_boundaries.md`
|
|
47
|
+
- `agent_onboarding/default/design_engineer/skills/api_and_interface_design.md`
|
|
48
|
+
- `agent_onboarding/default/design_engineer/skills/data_modeling.md`
|
|
49
|
+
- `agent_onboarding/default/design_engineer/skills/architecture_tradeoffs.md`
|
|
50
|
+
- `agent_onboarding/default/design_engineer/skills/adr_and_decision_hygiene.md`
|
|
51
|
+
- `agent_onboarding/default/design_engineer/skills/nonfunctional_requirements.md`
|
|
52
|
+
- `agent_onboarding/default/design_engineer/skills/design_review_protocol.md`
|
|
53
|
+
- `agent_onboarding/default/design_engineer/policies/design_quality_policy.md`
|
|
54
|
+
- `agent_onboarding/default/design_engineer/policies/decision_record_policy.md`
|
|
55
|
+
- `agent_onboarding/default/design_engineer/policies/design_review_policy.md`
|
|
56
|
+
- `agent_onboarding/default/design_engineer/policies/system_document_quality_rubric.md`
|
|
57
|
+
- `agent_onboarding/default/design_engineer/behavioral_guidelines/design_engineer_workflow.md`
|
|
58
|
+
- `agent_onboarding/default/design_engineer/behavioral_guidelines/design_validation_and_handoff.md`
|
|
59
|
+
- `agent_onboarding/default/design_engineer/examples/design_task_flow.md`
|
|
60
|
+
- `agent_onboarding/default/design_engineer/examples/adr_example.md`
|
|
61
|
+
|
|
62
|
+
On-demand design-context skills
|
|
63
|
+
Trigger conditions (any one makes these mandatory):
|
|
64
|
+
- The user asks for a full system/software design, architecture plan, or component boundary redesign.
|
|
65
|
+
- The task requires a design that changes an existing public contract, API, schema, or lifecycle boundary.
|
|
66
|
+
- The task requires creating/updating `system_docs/*` or making P0/P1 claims about architecture/components/tests.
|
|
67
|
+
|
|
68
|
+
If triggered:
|
|
69
|
+
- Apply the `engineer` on-demand system-context readset. The inheritance
|
|
70
|
+
header at the top of this file already puts it in the resolved chain, so
|
|
71
|
+
the paths are declared in the parent file and are not repeated here. The
|
|
72
|
+
triggers above are additional to the parent's, not a replacement.
|
|
73
|
+
- Do not proceed with architecture claims or edits until that on-demand readset is satisfied.
|
|
74
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# WORKFLOWS.MD - design_engineer
|
|
2
|
+
|
|
3
|
+
Purpose
|
|
4
|
+
- Define role-local workflow availability for the `design_engineer` role.
|
|
5
|
+
|
|
6
|
+
Inheritance
|
|
7
|
+
- `INHERITS_WORKFLOWS_FROM: agent_onboarding/default/engineer/WORKFLOWS.MD`
|
|
8
|
+
|
|
9
|
+
Activation rule
|
|
10
|
+
- This role inherits workflow behavior from `general` then `engineer`.
|
|
11
|
+
- Additional local workflows, when created, are user-generated and
|
|
12
|
+
user-approved only.
|
|
13
|
+
|
|
14
|
+
Active workflows
|
|
15
|
+
- none
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
|
|
2
|
+
# design_engineer_workflow
|
|
3
|
+
|
|
4
|
+
Purpose
|
|
5
|
+
- Describe the expected execution flow for design-engineer tasks.
|
|
6
|
+
|
|
7
|
+
Story steps
|
|
8
|
+
1) Confirm the goal and constraints.
|
|
9
|
+
- Ask clarifying questions before producing architecture.
|
|
10
|
+
2) Identify current state.
|
|
11
|
+
- Read tickets, `system_docs/*`, and code symbols as needed.
|
|
12
|
+
3) Produce a design draft.
|
|
13
|
+
- Include explicit options, tradeoffs, and UNKNOWNs.
|
|
14
|
+
4) Run a design review checkpoint.
|
|
15
|
+
- Request approval when required.
|
|
16
|
+
5) Produce handoff artifacts.
|
|
17
|
+
- Ticketize the work and define validation/rollout.
|
|
18
|
+
6) Transition to implementation (if requested).
|
|
19
|
+
- Follow `engineer` execution discipline.
|
|
20
|
+
|
|
21
|
+
References
|
|
22
|
+
- `agent_onboarding/default/design_engineer/behavioral_guidelines/design_validation_and_handoff.md`
|
|
23
|
+
- `agent_onboarding/default/engineer/skills/engineer_execution.md`
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
|
|
2
|
+
# design_validation_and_handoff
|
|
3
|
+
|
|
4
|
+
Purpose
|
|
5
|
+
- Define what "validated design" means and how to hand off to implementation.
|
|
6
|
+
|
|
7
|
+
Validation checklist
|
|
8
|
+
- Interfaces are explicit (API/schema/event contracts).
|
|
9
|
+
- Failure modes are identified with mitigations.
|
|
10
|
+
- Test strategy is explicit and covers core invariants.
|
|
11
|
+
- Rollout strategy is explicit and includes backout.
|
|
12
|
+
- Observability hooks are defined for the new behavior.
|
|
13
|
+
- Tickets are broken down into actionable units with dependencies.
|
|
14
|
+
|
|
15
|
+
Handoff rules
|
|
16
|
+
- If implementation is requested:
|
|
17
|
+
- identify the minimal set of files/modules to change,
|
|
18
|
+
- hand off to `engineer` execution discipline,
|
|
19
|
+
- ensure each ticket has acceptance criteria and validation steps.
|
|
20
|
+
|
|
21
|
+
References
|
|
22
|
+
- `agent_onboarding/default/general/skills/ticketing_skill_contract.md`
|
|
23
|
+
- `agent_onboarding/default/engineer/behavioral_guidelines/task_execution_and_validation.md`
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# ADR Example (Template)
|
|
3
|
+
|
|
4
|
+
Title
|
|
5
|
+
- ADR-000: <short decision name>
|
|
6
|
+
|
|
7
|
+
Status
|
|
8
|
+
- proposed | accepted | superseded
|
|
9
|
+
|
|
10
|
+
Context
|
|
11
|
+
- What problem are we solving?
|
|
12
|
+
- What constraints exist?
|
|
13
|
+
- What evidence links to current state?
|
|
14
|
+
|
|
15
|
+
Decision
|
|
16
|
+
- What are we doing?
|
|
17
|
+
|
|
18
|
+
Options considered
|
|
19
|
+
- Option A:
|
|
20
|
+
- Option B:
|
|
21
|
+
- Option C (optional):
|
|
22
|
+
|
|
23
|
+
Tradeoffs
|
|
24
|
+
- Why this option wins
|
|
25
|
+
- What we give up
|
|
26
|
+
|
|
27
|
+
Consequences
|
|
28
|
+
- What changes for implementers and operators?
|
|
29
|
+
- Compatibility and migration impacts
|
|
30
|
+
|
|
31
|
+
Validation
|
|
32
|
+
- Tests and checks
|
|
33
|
+
- Observability and rollout plan
|
|
34
|
+
|
|
35
|
+
Links
|
|
36
|
+
- Ticket:
|
|
37
|
+
- Code:
|
|
38
|
+
- Docs:
|
|
39
|
+
|
|
40
|
+
|
contextcompass_cli/_package/agent_onboarding/default/design_engineer/examples/design_task_flow.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# Design Engineer Example: Design Task Flow
|
|
3
|
+
|
|
4
|
+
Context
|
|
5
|
+
- The user asks for a new feature that requires architectural changes.
|
|
6
|
+
- Goal: produce an implementable design and break work into tickets.
|
|
7
|
+
|
|
8
|
+
Example flow
|
|
9
|
+
1) Clarify goal, constraints, and compatibility requirements.
|
|
10
|
+
2) Read current system docs or code to understand boundaries.
|
|
11
|
+
3) Draft design:
|
|
12
|
+
- components + responsibilities,
|
|
13
|
+
- interfaces + contracts,
|
|
14
|
+
- data model impacts,
|
|
15
|
+
- failure modes + mitigations,
|
|
16
|
+
- test strategy,
|
|
17
|
+
- rollout/observability.
|
|
18
|
+
4) Present options + tradeoffs and recommend one.
|
|
19
|
+
5) Request design approval checkpoint (if required).
|
|
20
|
+
6) Ticketize:
|
|
21
|
+
- create story/task breakdown with dependencies and acceptance criteria.
|
|
22
|
+
7) Hand off to implementation plan (if requested).
|
|
23
|
+
|
|
24
|
+
Expected output format (sample)
|
|
25
|
+
- Questions:
|
|
26
|
+
- Current state (evidence):
|
|
27
|
+
- Design draft:
|
|
28
|
+
- Options + tradeoffs:
|
|
29
|
+
- Recommendation:
|
|
30
|
+
- Approval needed:
|
|
31
|
+
- Ticket breakdown:
|
|
32
|
+
|
|
33
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
|
|
2
|
+
# decision_record_policy
|
|
3
|
+
|
|
4
|
+
Purpose
|
|
5
|
+
- Require durable decision recording for high-impact architecture/design changes.
|
|
6
|
+
|
|
7
|
+
Policy
|
|
8
|
+
- When a design decision changes:
|
|
9
|
+
- public APIs,
|
|
10
|
+
- schemas/data models,
|
|
11
|
+
- component boundaries/ownership,
|
|
12
|
+
- lifecycle invariants,
|
|
13
|
+
- cross-cutting behavior (auth/retries/caching/observability),
|
|
14
|
+
you MUST record the decision as an ADR or ticket-linked decision artifact.
|
|
15
|
+
- The decision record must include:
|
|
16
|
+
- context, decision, options, tradeoffs, consequences, validation, rollout.
|
|
17
|
+
- Do not proceed to implementation until decision recording is complete
|
|
18
|
+
when the change is hard to reverse.
|
|
19
|
+
|
|
20
|
+
References
|
|
21
|
+
- `agent_onboarding/default/design_engineer/skills/adr_and_decision_hygiene.md`
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
|
|
2
|
+
# design_quality_policy
|
|
3
|
+
|
|
4
|
+
Purpose
|
|
5
|
+
- Establish the quality bar for design artifacts produced by `design_engineer`.
|
|
6
|
+
|
|
7
|
+
Policy
|
|
8
|
+
- Design output must be implementable and testable, not conceptual only.
|
|
9
|
+
- For any non-trivial design, include:
|
|
10
|
+
- goal/non-goals,
|
|
11
|
+
- constraints,
|
|
12
|
+
- assumptions + UNKNOWNs,
|
|
13
|
+
- options + tradeoffs,
|
|
14
|
+
- architecture + interfaces,
|
|
15
|
+
- NFR coverage,
|
|
16
|
+
- test/validation plan,
|
|
17
|
+
- rollout/observability plan,
|
|
18
|
+
- ticketization plan.
|
|
19
|
+
- Use evidence pointers for current-state claims.
|
|
20
|
+
- Do not hide risks: call them out with severity and proposed mitigations.
|
|
21
|
+
|
|
22
|
+
Unknowns Gate
|
|
23
|
+
- Apply the canonical policy in
|
|
24
|
+
`agent_onboarding/default/general/skills/unknowns_gate_reference.md`.
|
|
25
|
+
|
|
26
|
+
References
|
|
27
|
+
- `agent_onboarding/default/design_engineer/skills/system_design_method.md`
|
|
28
|
+
- `agent_onboarding/default/design_engineer/skills/architecture_tradeoffs.md`
|
|
29
|
+
|
|
30
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
|
|
2
|
+
# design_review_policy
|
|
3
|
+
|
|
4
|
+
Purpose
|
|
5
|
+
- Enforce a design-review checkpoint before implementation for high-impact changes.
|
|
6
|
+
|
|
7
|
+
Policy
|
|
8
|
+
A design review checkpoint is mandatory when:
|
|
9
|
+
- the design changes public contracts, schemas, or major component boundaries, OR
|
|
10
|
+
- the design introduces non-trivial operational risk, OR
|
|
11
|
+
- the user requested "design first" explicitly.
|
|
12
|
+
|
|
13
|
+
Checkpoint rule
|
|
14
|
+
- Provide a structured design summary + open questions.
|
|
15
|
+
- Request explicit approval before implementation.
|
|
16
|
+
- Approval must be recorded (in the response and ideally in the ticket notes).
|
|
17
|
+
|
|
18
|
+
References
|
|
19
|
+
- `agent_onboarding/default/design_engineer/skills/design_review_protocol.md`
|
|
20
|
+
- `agent_onboarding/default/general/skills/ticket_microcycle.md`
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# system_document_quality_rubric
|
|
4
|
+
|
|
5
|
+
Purpose
|
|
6
|
+
- Score the four system documents on whether they *say* anything, not merely
|
|
7
|
+
whether their required fields exist.
|
|
8
|
+
- Give downstream work a threshold it can refuse on.
|
|
9
|
+
|
|
10
|
+
Scope
|
|
11
|
+
- Applies to `system_docs/src_architecture.md`, `src_components.md`,
|
|
12
|
+
`tests_architecture.md`, and `tests_components.md`, whenever one is created,
|
|
13
|
+
recomposed, or reviewed.
|
|
14
|
+
- One rubric, four profiles. The criteria and weights below are shared; only the
|
|
15
|
+
anchors change per document. Two rubric idioms in one repository drift apart,
|
|
16
|
+
and then neither is trusted.
|
|
17
|
+
- Vocabulary is deliberately the same as
|
|
18
|
+
`agent_onboarding/default/engineer/policies/ctx_autonomy_rubric.md`: weighted
|
|
19
|
+
criteria, 0/3/5 anchors, 0-100 bands, a refusal threshold. Learn it once.
|
|
20
|
+
|
|
21
|
+
## The hole this fills
|
|
22
|
+
|
|
23
|
+
Every other gate in this system is binary. The Quality Gate asks whether
|
|
24
|
+
`Concurrency/Threading` is present. It is present, so the gate passes:
|
|
25
|
+
|
|
26
|
+
> Concurrency/Threading: Uses a lock.
|
|
27
|
+
|
|
28
|
+
That scores identically to:
|
|
29
|
+
|
|
30
|
+
> Concurrency/Threading: Single writer lock held across the flush; readers take
|
|
31
|
+
> the snapshot instead. Acquired before the queue lock, never after - the
|
|
32
|
+
> reverse order deadlocked under concurrent flush and drain.
|
|
33
|
+
|
|
34
|
+
Both satisfy the contract. Only one is worth reading. Structural gates verify a
|
|
35
|
+
field exists; nothing until now verified it carries information. That gap is the
|
|
36
|
+
difference between a document that satisfies a contract and one a reader can act
|
|
37
|
+
on after compaction.
|
|
38
|
+
|
|
39
|
+
This rubric does not replace the Quality Gate or the Content Preservation Gate.
|
|
40
|
+
Those are pass/fail and come first. A document that fails either is not scored -
|
|
41
|
+
it is fixed.
|
|
42
|
+
|
|
43
|
+
## Ranking model (0-100)
|
|
44
|
+
|
|
45
|
+
Score each criterion 0-5, then compute `sum((score / 5) * weight)`.
|
|
46
|
+
|
|
47
|
+
| criterion | weight |
|
|
48
|
+
| --- | --- |
|
|
49
|
+
| Fidelity to source | 30 |
|
|
50
|
+
| Contract completeness | 15 |
|
|
51
|
+
| Depth | 15 |
|
|
52
|
+
| Addressability | 15 |
|
|
53
|
+
| Join integrity | 15 |
|
|
54
|
+
| Mirror agreement | 10 |
|
|
55
|
+
|
|
56
|
+
Fidelity carries double weight because every other criterion is recoverable by
|
|
57
|
+
editing. A confidently wrong claim is not - it propagates into decisions before
|
|
58
|
+
anyone tests it.
|
|
59
|
+
|
|
60
|
+
## Shared anchors (0/3/5)
|
|
61
|
+
|
|
62
|
+
**Fidelity to source**
|
|
63
|
+
- 5: every non-obvious claim carries a file or symbol reference a reader can
|
|
64
|
+
open. Claims match what is there.
|
|
65
|
+
- 3: mostly accurate; some claims plausible but uncited.
|
|
66
|
+
- 0: claims contradicted by the sources, or inferred from names alone. Naming
|
|
67
|
+
inference is the specific failure - `*_manager` does not establish that a
|
|
68
|
+
thing manages anything.
|
|
69
|
+
|
|
70
|
+
**Contract completeness**
|
|
71
|
+
- 5: every required section and field present, in contract order, and each one
|
|
72
|
+
populated with content specific to this subject.
|
|
73
|
+
- 3: all present, one or more hollow - a field restating its own name.
|
|
74
|
+
- 0: required sections missing, or reordered so a reader cannot navigate by
|
|
75
|
+
contract.
|
|
76
|
+
|
|
77
|
+
Scoring note: a field deliberately marked not-applicable, with the reason, is a
|
|
78
|
+
5. A field left blank is a 0. They look identical to a reader, and only one of
|
|
79
|
+
them is a decision.
|
|
80
|
+
|
|
81
|
+
**Depth**
|
|
82
|
+
- 5: names the mechanism, the ordering it depends on, and the failure it
|
|
83
|
+
prevents. Testable as written.
|
|
84
|
+
- 3: correct but one clause; a reader knows *that* something happens, not how or
|
|
85
|
+
why it must.
|
|
86
|
+
- 0: aspirational or decorative. "Handles errors gracefully."
|
|
87
|
+
|
|
88
|
+
**Addressability**
|
|
89
|
+
- 5: exactly one H1; navigable units at consistent depth; every section name
|
|
90
|
+
unique; no wrapped headings; no container heading usable as a read target.
|
|
91
|
+
- 3: unique and unwrapped, but a container heading exists that a reader could
|
|
92
|
+
select by mistake.
|
|
93
|
+
- 0: duplicate section names, or a heading spanning two physical lines. Both
|
|
94
|
+
return content on a slice - the wrong content, confidently.
|
|
95
|
+
|
|
96
|
+
**Join integrity**
|
|
97
|
+
- 5: every cited path resolves, and every range was measured on this pass.
|
|
98
|
+
- 3: paths resolve; ranges carried forward from a previous pass without
|
|
99
|
+
remeasuring.
|
|
100
|
+
- 0: unresolvable citations, a stale index, or ranges that parse and point
|
|
101
|
+
somewhere else.
|
|
102
|
+
|
|
103
|
+
The join differs by side and the difference is not cosmetic - see the profiles.
|
|
104
|
+
|
|
105
|
+
**Mirror agreement**
|
|
106
|
+
- 5: the document pairs with its counterpart - same section contract shape, same
|
|
107
|
+
terms for the same things, no boundary described one way here and another way
|
|
108
|
+
there.
|
|
109
|
+
- 3: structurally aligned, terminology drifted.
|
|
110
|
+
- 0: the pair contradict each other, or one is current and the other describes a
|
|
111
|
+
boundary that moved.
|
|
112
|
+
|
|
113
|
+
`system_document_build.md` already declares these are mirrors and that
|
|
114
|
+
divergence *is* the defect. That makes this scoreable in both directions: when a
|
|
115
|
+
pair disagree, both documents lose the points, because the rubric cannot tell
|
|
116
|
+
which one is wrong and neither can a reader.
|
|
117
|
+
|
|
118
|
+
## Score bands
|
|
119
|
+
|
|
120
|
+
- 90-100: A - trusted as an input to design decisions
|
|
121
|
+
- 75-89: B - usable
|
|
122
|
+
- 60-74: C - usable, schedule a refresh before high-risk work
|
|
123
|
+
- 40-59: D - weak
|
|
124
|
+
- 0-39: F - unusable
|
|
125
|
+
|
|
126
|
+
Actions:
|
|
127
|
+
- **< 60: refuse downstream work that depends on this document.** Refresh it
|
|
128
|
+
first. Do not synthesize a higher-level claim from it, and do not cite it as
|
|
129
|
+
evidence in a ticket.
|
|
130
|
+
- 60-74: proceed if necessary, and record the score and the weak criterion in
|
|
131
|
+
the active ticket so the next reader inherits the caveat rather than the
|
|
132
|
+
false confidence.
|
|
133
|
+
- 75+: proceed.
|
|
134
|
+
|
|
135
|
+
## Profiles
|
|
136
|
+
|
|
137
|
+
### src_architecture
|
|
138
|
+
|
|
139
|
+
- **Navigable unit**: the H2 concern.
|
|
140
|
+
- **Depth** means boundaries, invariants and failure paths stated concretely
|
|
141
|
+
enough to test. A boundary claim scores 5 when a reader can name what crosses
|
|
142
|
+
it and what is refused.
|
|
143
|
+
- **Join integrity** is the C1 map: cited paths resolve into the graph index,
|
|
144
|
+
ranges measured.
|
|
145
|
+
- **Mirror**: pairs with `tests_architecture.md`.
|
|
146
|
+
|
|
147
|
+
### src_components
|
|
148
|
+
|
|
149
|
+
- **Navigable unit**: the H3 component entry.
|
|
150
|
+
- **Depth is assessed per entry across the twelve fields**, then averaged - not
|
|
151
|
+
judged from the document as a whole. One excellent entry does not lift eleven
|
|
152
|
+
hollow ones, and a document-level impression is exactly how hollow entries
|
|
153
|
+
survive review.
|
|
154
|
+
- **Join integrity** is `Key Files (C1)`, verified with the recipe in
|
|
155
|
+
`src_components_instructions.md`, not assumed.
|
|
156
|
+
- **Mirror**: pairs with `tests_components.md`.
|
|
157
|
+
|
|
158
|
+
### tests_architecture
|
|
159
|
+
|
|
160
|
+
Mirror of the source architecture profile, plus one criterion that overrides
|
|
161
|
+
Fidelity when it fails:
|
|
162
|
+
|
|
163
|
+
- **Does it describe the test system's own boundaries, layers and harness
|
|
164
|
+
ownership** - or does it restate source architecture in test vocabulary? A
|
|
165
|
+
document whose diagram could be dropped into `src_architecture.md` unchanged
|
|
166
|
+
is describing the wrong system, and scores 0 on Fidelity regardless of how
|
|
167
|
+
accurate its sentences are. It is accurate about the wrong subject.
|
|
168
|
+
|
|
169
|
+
- **Join integrity is weaker here, and knowing that is the point.** The graph is
|
|
170
|
+
built from the source tree, so source-side citations are checked against
|
|
171
|
+
`src_graph_index.md` for free. This document cites test paths, which appear in
|
|
172
|
+
no graph. Nothing will tell you a path here has rotted. Score 5 only when
|
|
173
|
+
existence was checked and ranges were remeasured on this pass; carried-forward
|
|
174
|
+
ranges cap this criterion at 3.
|
|
175
|
+
|
|
176
|
+
### tests_components
|
|
177
|
+
|
|
178
|
+
Mirror of the source components profile, plus:
|
|
179
|
+
|
|
180
|
+
- **Does each test surface name what it validates and who owns it?** An entry
|
|
181
|
+
that describes a harness without naming the behaviour it protects scores at
|
|
182
|
+
most 3 on Depth. "Runs the suite" is not a responsibility.
|
|
183
|
+
- **`Key Files (C1)` cites test paths**, and the join is existence plus
|
|
184
|
+
remeasurement, per `tests_components_instructions.md`.
|
|
185
|
+
|
|
186
|
+
## Weight the test side equally, and expect it to score lower
|
|
187
|
+
|
|
188
|
+
The test profiles carry the same weights as the source profiles. Not because the
|
|
189
|
+
two halves are equally mature - they are usually not - but because weighting the
|
|
190
|
+
test side lower encodes the neglect instead of measuring it.
|
|
191
|
+
|
|
192
|
+
Expect lower scores at first. In the repository this rubric was developed
|
|
193
|
+
against, both source indexes had been maintained and both test indexes were
|
|
194
|
+
stale. That asymmetry is the normal case: the test-side documents are written
|
|
195
|
+
once, during a push, and then nothing forces them forward, because no build
|
|
196
|
+
breaks when they rot.
|
|
197
|
+
|
|
198
|
+
A rubric that scores all four surfaces makes that visible on every pass rather
|
|
199
|
+
than letting it sit. The first run against an established repository should be
|
|
200
|
+
read as a baseline, not an indictment - what matters is the second run.
|
|
201
|
+
|
|
202
|
+
## Scoring discipline
|
|
203
|
+
|
|
204
|
+
- **Score against the document, not your memory of building it.** Re-read it.
|
|
205
|
+
- **Cite what you scored.** A criterion scored below 5 needs a `path:line`
|
|
206
|
+
example of the weakness, otherwise the score is unactionable and the next
|
|
207
|
+
reader re-derives it from scratch.
|
|
208
|
+
- **Score the whole document once, not each section separately**, except where a
|
|
209
|
+
profile says otherwise - the components profiles average per entry precisely
|
|
210
|
+
because whole-document impressions hide hollow entries.
|
|
211
|
+
- **Do not score your own work as the last step of building it.** The build pass
|
|
212
|
+
and the scoring pass want opposite postures. If the same agent must do both,
|
|
213
|
+
score from the file on disk after the index rebuild, never from the draft in
|
|
214
|
+
context.
|
|
215
|
+
- Record the total, the per-criterion scores, and the band in the active ticket.
|
|
216
|
+
A score with no record is a score nobody can challenge.
|
|
217
|
+
|
|
218
|
+
## Anti-patterns (reject)
|
|
219
|
+
|
|
220
|
+
- Scoring 5 on Fidelity because nothing looked wrong. Absence of a caught error
|
|
221
|
+
is not evidence of accuracy.
|
|
222
|
+
- Rounding a document up to clear the 60 threshold so work can continue. The
|
|
223
|
+
threshold exists to stop exactly that.
|
|
224
|
+
- Treating a high Contract completeness score as a proxy for quality. It is 15
|
|
225
|
+
points of 100, and it is the one criterion a structural gate already covers.
|
|
226
|
+
- Averaging the four documents into a single repository score. They are read
|
|
227
|
+
separately, they rot separately, and a strong source half will mask a
|
|
228
|
+
worthless test half.
|
|
229
|
+
|
|
230
|
+
## References
|
|
231
|
+
- `agent_onboarding/default/engineer/policies/ctx_autonomy_rubric.md`
|
|
232
|
+
- `agent_onboarding/default/engineer/skills/system_document_build.md`
|
|
233
|
+
- `agent_onboarding/default/design_engineer/skills/src_architecture_instructions.md`
|
|
234
|
+
- `agent_onboarding/default/design_engineer/skills/src_components_instructions.md`
|
|
235
|
+
- `agent_onboarding/default/design_engineer/skills/tests_architecture_instructions.md`
|
|
236
|
+
- `agent_onboarding/default/design_engineer/skills/tests_components_instructions.md`
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# adr_and_decision_hygiene
|
|
3
|
+
|
|
4
|
+
Purpose
|
|
5
|
+
- Keep architecture decisions durable, searchable, and explainable.
|
|
6
|
+
- Prevent re-litigating decisions after compaction/handoffs.
|
|
7
|
+
|
|
8
|
+
When to write a decision record (ADR or ticket-linked decision)
|
|
9
|
+
- Any change to:
|
|
10
|
+
- public API contracts,
|
|
11
|
+
- persistent schemas/data models,
|
|
12
|
+
- component boundaries and ownership,
|
|
13
|
+
- lifecycle invariants and cleanup behavior,
|
|
14
|
+
- cross-cutting behavior (auth, caching, retries, observability).
|
|
15
|
+
- Any decision that is hard to reverse.
|
|
16
|
+
|
|
17
|
+
ADR template (minimal)
|
|
18
|
+
- Title:
|
|
19
|
+
- Status: proposed | accepted | superseded
|
|
20
|
+
- Context:
|
|
21
|
+
- Decision:
|
|
22
|
+
- Options considered:
|
|
23
|
+
- Tradeoffs:
|
|
24
|
+
- Consequences:
|
|
25
|
+
- Rollout/migration:
|
|
26
|
+
- Test/validation:
|
|
27
|
+
- Links: tickets, code, docs
|
|
28
|
+
|
|
29
|
+
Rules
|
|
30
|
+
- One ADR = one decision.
|
|
31
|
+
- Link ADR to the ticket that implements it.
|
|
32
|
+
- If superseded, link to the newer ADR and keep the old one for history.
|
|
33
|
+
|
|
34
|
+
References
|
|
35
|
+
- `agent_onboarding/default/design_engineer/policies/decision_record_policy.md`
|
|
36
|
+
- `agent_onboarding/default/design_engineer/examples/adr_example.md`
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# api_and_interface_design
|
|
3
|
+
|
|
4
|
+
Purpose
|
|
5
|
+
- Define interface design discipline for APIs and internal contracts.
|
|
6
|
+
- Prevent breaking changes and ambiguous error behavior.
|
|
7
|
+
|
|
8
|
+
Core rules
|
|
9
|
+
- Every interface must define:
|
|
10
|
+
- inputs (types, validation),
|
|
11
|
+
- outputs (types, semantics),
|
|
12
|
+
- error behavior (codes, retries, invariants),
|
|
13
|
+
- versioning/compatibility strategy.
|
|
14
|
+
- Prefer explicit, stable, boring contracts over "smart" implicit behavior.
|
|
15
|
+
- If idempotency matters, define it explicitly.
|
|
16
|
+
- If pagination matters, define it explicitly.
|
|
17
|
+
- If timeouts/retries matter, define them explicitly.
|
|
18
|
+
|
|
19
|
+
Error semantics checklist
|
|
20
|
+
- What errors are user-correctable vs system errors?
|
|
21
|
+
- What errors are retryable and under what conditions?
|
|
22
|
+
- Are errors stable enough to be relied on by callers?
|
|
23
|
+
- Do errors leak secrets or sensitive details?
|
|
24
|
+
|
|
25
|
+
Versioning/compatibility checklist
|
|
26
|
+
- Backward compatibility window
|
|
27
|
+
- Deprecation mechanism
|
|
28
|
+
- Migration strategy
|
|
29
|
+
- Rollout plan that supports mixed versions
|
|
30
|
+
|
|
31
|
+
References
|
|
32
|
+
- `agent_onboarding/default/design_engineer/skills/adr_and_decision_hygiene.md`
|
|
33
|
+
- `agent_onboarding/default/design_engineer/skills/nonfunctional_requirements.md`
|
|
34
|
+
- `agent_onboarding/default/engineer/skills/documentation_standards.md`
|
|
35
|
+
|
|
36
|
+
|