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,27 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# synaptic_python_developer profile_overrides
|
|
4
|
+
|
|
5
|
+
Purpose
|
|
6
|
+
- Define the user-specific overlay scope for this profile.
|
|
7
|
+
- Keep default `general` and `engineer` baselines reusable for public users.
|
|
8
|
+
|
|
9
|
+
Resolved inheritance
|
|
10
|
+
- `general` -> `engineer` -> `synaptic_python_developer`
|
|
11
|
+
- Source of truth:
|
|
12
|
+
`agent_onboarding/user_defined/synaptic_python_developer/SKILLS.MD` header
|
|
13
|
+
`INHERITS_SKILLS_FROM: agent_onboarding/default/engineer/SKILLS.MD` and
|
|
14
|
+
the engineer header chain to `agent_onboarding/default/general/SKILLS.MD`.
|
|
15
|
+
|
|
16
|
+
Overlay scope
|
|
17
|
+
- User-preference collaboration tone and engagement style.
|
|
18
|
+
- User-preference pushback intensity and clarification cadence.
|
|
19
|
+
- User-specific operating emphasis that should not be required for public
|
|
20
|
+
default onboarding paths.
|
|
21
|
+
|
|
22
|
+
References
|
|
23
|
+
- `agent_onboarding/user_defined/synaptic_python_developer/policies/synaptic_policy_overrides.md`
|
|
24
|
+
- `agent_onboarding/user_defined/synaptic_python_developer/skills/synaptic_skill_overrides.md`
|
|
25
|
+
- `agent_onboarding/user_defined/synaptic_python_developer/behavioral_guidelines/synaptic_behavior_overrides.md`
|
|
26
|
+
|
|
27
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
"""Attribute aliasing micro benchmark example."""
|
|
2
|
+
|
|
3
|
+
import timeit
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
class Sample:
|
|
7
|
+
def __init__(self) -> None:
|
|
8
|
+
self.value = 1
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def direct(obj: Sample) -> int:
|
|
12
|
+
total = 0
|
|
13
|
+
for _ in range(1000):
|
|
14
|
+
total += obj.value
|
|
15
|
+
return total
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
def aliased(obj: Sample) -> int:
|
|
19
|
+
total = 0
|
|
20
|
+
value = obj.value
|
|
21
|
+
for _ in range(1000):
|
|
22
|
+
total += value
|
|
23
|
+
return total
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
def run() -> tuple[float, float]:
|
|
27
|
+
obj = Sample()
|
|
28
|
+
d = timeit.timeit(lambda: direct(obj), number=2000)
|
|
29
|
+
a = timeit.timeit(lambda: aliased(obj), number=2000)
|
|
30
|
+
return d, a
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
if __name__ == "__main__":
|
|
34
|
+
direct_t, aliased_t = run()
|
|
35
|
+
print(f"direct={direct_t:.6f}s aliased={aliased_t:.6f}s")
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# banned_patterns
|
|
4
|
+
|
|
5
|
+
Purpose
|
|
6
|
+
- Prevent unsafe or non-auditable behavior.
|
|
7
|
+
|
|
8
|
+
Attribute Access Rule (No Defensive Introspection in Owned Code)
|
|
9
|
+
If we own the file/module and the attribute names are visible in the code, do NOT use getattr() / hasattr() as a defensive pattern.
|
|
10
|
+
|
|
11
|
+
* Use direct access (obj.attr).
|
|
12
|
+
* Handle None explicitly where appropriate.
|
|
13
|
+
* If you genuinely need to handle a missing attribute on an external/optional dependency, call it directly and catch AttributeError instead of probing with hasattr. This keeps owned-code contracts strict while still being safe when the contract is ambiguous or external.
|
|
14
|
+
|
|
15
|
+
getattr() / hasattr() are allowed only in ambiguous situations, meaning at least one is true:
|
|
16
|
+
* The object is polymorphic/external and its attribute contract is not visible in our code.
|
|
17
|
+
* The attribute/method is optional by design (capability checks).
|
|
18
|
+
* The attribute name is truly dynamic.
|
|
19
|
+
|
|
20
|
+
Polymorphic lock cleanup exception (allowed):
|
|
21
|
+
* For lock-like objects that may be different implementations, capability checks are allowed:
|
|
22
|
+
if hasattr(lock, "cleanup"): lock.cleanup()
|
|
23
|
+
|
|
24
|
+
Disallowed example (we own it / visible contract):
|
|
25
|
+
* getattr(self, "_foo", None) when _foo is clearly part of our class/object contract in this file.
|
|
26
|
+
|
|
27
|
+
Defensive local alias for nullable owned dependency (banned)
|
|
28
|
+
If a dependency is part of the owned class contract, do not treat it as optional at access time.
|
|
29
|
+
Do not create a local alias just to guard a potentially None owned dependency.
|
|
30
|
+
Guarantee initialization through the lifecycle and use direct self references.
|
|
31
|
+
Do not silently return defaults in hot path accessors.
|
|
32
|
+
|
|
33
|
+
Snapshotting owned structures for reads (banned)
|
|
34
|
+
Do not snapshot owned registries/maps/lists into locals or copies for read access.
|
|
35
|
+
Use the live structure directly when it is part of the owned contract.
|
|
36
|
+
Snapshotting is allowed only when required for correctness (for example, iterating
|
|
37
|
+
while mutation is expected or when a defensive copy is explicitly mandated by the
|
|
38
|
+
method contract). When snapshotting is required, document the reason in the
|
|
39
|
+
method docstring or a targeted comment.
|
|
40
|
+
|
|
41
|
+
Disallowed example (defensive local alias):
|
|
42
|
+
```
|
|
43
|
+
@property
|
|
44
|
+
def validated(self) -> bool:
|
|
45
|
+
""" True if the validation phase has run and marked this spell as validated. """
|
|
46
|
+
crafter = self._crafter
|
|
47
|
+
return crafter.validated if crafter is not None else False
|
|
48
|
+
|
|
49
|
+
@property
|
|
50
|
+
def is_broken(self) -> bool:
|
|
51
|
+
""" True if the validation phase classified this spell as broken / unsafe. """
|
|
52
|
+
crafter = self._crafter
|
|
53
|
+
return crafter.is_broken if crafter is not None else False
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Banned / Disallowed Patterns
|
|
57
|
+
* Never use type: ignore.
|
|
58
|
+
* Never use # noqa.
|
|
59
|
+
* eval() / exec() / compile() are allowed for agent work when codegen is required.
|
|
60
|
+
* Never use wildcard imports (e.g., from module import *).
|
|
61
|
+
* Never use PEP 604 union syntax (e.g., A | B, T | None); use Optional/Union.
|
|
62
|
+
|
|
63
|
+
Never use
|
|
64
|
+
- type: ignore
|
|
65
|
+
- # noqa
|
|
66
|
+
- eval() / exec() / compile() for non-codegen work
|
|
67
|
+
- wildcard imports
|
|
68
|
+
- from __future__ import annotations (new files must not add this)
|
|
69
|
+
- Python 3.14 already provides deferred annotations by default, so this is not
|
|
70
|
+
a valid workaround for typing-only import pressure
|
|
71
|
+
- PEP 604 unions (A | B, T | None); use Optional/Union
|
|
72
|
+
- fake local Protocol/ABC enforcement surfaces when a truthful concrete type
|
|
73
|
+
plus `typing.TYPE_CHECKING` import would solve the typing-only dependency
|
|
74
|
+
- `else: TypeName = Any` fallback aliases under `TYPE_CHECKING`
|
|
75
|
+
- widening truthful concrete collaborator types to `Any` instead of raising the
|
|
76
|
+
conflict to the user
|
|
77
|
+
|
|
78
|
+
Dataclass restrictions
|
|
79
|
+
- Do not use dataclasses to store object references or owned resources.
|
|
80
|
+
- Dataclasses may only contain value types (str, int, float, bool, None) and containers of those value types.
|
|
81
|
+
- If object references are required, use a normal class with explicit cleanup.
|
|
82
|
+
|
|
83
|
+
Cleanup/disposal guidance
|
|
84
|
+
- Proper usage: `agent_onboarding/user_defined/synaptic_python_developer/skills/python/cleanup_and_disposal.md`
|
|
85
|
+
- Anti-patterns: `agent_onboarding/user_defined/synaptic_python_developer/examples/python/anti_patterns.py`
|
|
86
|
+
- Cleanup/disposal anti-patterns (summary):
|
|
87
|
+
- Snapshotting owned `self._fields` into locals as defensive cleanup guards.
|
|
88
|
+
- Defensive `None` checks on owned fields when lifecycle guarantees they exist.
|
|
89
|
+
- Relying on GC for owned resources instead of explicit cleanup.
|
|
90
|
+
- Keeping stale owned references alive after cleanup.
|
|
91
|
+
- Using `None` by default when the contract does not need a retained
|
|
92
|
+
post-cleanup tombstone field.
|
|
93
|
+
- Cleaning loggers before owned children.
|
|
94
|
+
- Placeholder comments like "already nulled above" or "already deleted above"
|
|
95
|
+
instead of the actual teardown actions.
|
|
96
|
+
|
|
97
|
+
Owned-code strictness
|
|
98
|
+
- Do not use getattr/hasattr for owned attributes.
|
|
99
|
+
- Handle AttributeError only for truly optional external interfaces.
|
|
100
|
+
- Do not replace honest `TYPE_CHECKING` imports with fake structural shims just
|
|
101
|
+
to avoid a typing-only dependency edge.
|
|
102
|
+
|
|
103
|
+
Exception
|
|
104
|
+
- Polymorphic lock cleanup may use hasattr(lock, "cleanup").
|
|
105
|
+
|
|
106
|
+
Examples
|
|
107
|
+
- agent_onboarding/user_defined/synaptic_python_developer/examples/python/anti_patterns.py
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# cleanup_and_disposal
|
|
4
|
+
|
|
5
|
+
Purpose
|
|
6
|
+
- Enforce deterministic, idempotent cleanup with explicit post-teardown field policy.
|
|
7
|
+
|
|
8
|
+
Cleanup / Teardown Discipline (Immediately After Initialization)
|
|
9
|
+
|
|
10
|
+
Cleanup is a core part of this library's correctness contract.
|
|
11
|
+
* Cleanup must be deterministic and idempotent.
|
|
12
|
+
* Prefer object teardown: call cleanup() on child objects, then delete owned
|
|
13
|
+
references to drop the live surface and prevent use-after-clean.
|
|
14
|
+
* Look at existing implementations of the class for patterns to better understand requirements. We cleanup everything; do not leave it to the GC.
|
|
15
|
+
* Logger teardown last.
|
|
16
|
+
* Do not use placeholder comments like "already deleted above." Write the
|
|
17
|
+
actual teardown assignments or deletes.
|
|
18
|
+
|
|
19
|
+
Cleanup teardown contract:
|
|
20
|
+
* Default posture: after cleaning children, delete owned field references with
|
|
21
|
+
`del self._field` so the object stops exposing stale state.
|
|
22
|
+
* Allowed exception: set a field to `None` only when the contract explicitly
|
|
23
|
+
needs a retained post-cleanup tombstone surface for callers, tests, or
|
|
24
|
+
diagnostic introspection.
|
|
25
|
+
* If a field is kept as `None` instead of deleted, that must be intentional and
|
|
26
|
+
documented.
|
|
27
|
+
|
|
28
|
+
Post-cleanup usage rule
|
|
29
|
+
* If a class implements cleanup, assume the object is not used after cleanup completes.
|
|
30
|
+
* Prefer `self.check_cleaned()` and allow it to throw for methods that require a live object.
|
|
31
|
+
* Only use `if self._cleaned: return` when the method must be non-throwing by contract.
|
|
32
|
+
* Do NOT snapshot `self._field` into locals unless absolutely necessary and justified.
|
|
33
|
+
* Do NOT guard internal fields with `if x is None` when lifecycle guarantees they exist pre-cleanup.
|
|
34
|
+
* `None` checks are for external inputs, truly optional state, or deliberately
|
|
35
|
+
retained tombstone fields only.
|
|
36
|
+
|
|
37
|
+
Rules
|
|
38
|
+
- Cleanup implemented immediately after __init__.
|
|
39
|
+
- If your base class defines a cleanup contract, prefer deleting owned fields
|
|
40
|
+
after cleanup. Use `None`
|
|
41
|
+
only when the class contract explicitly requires a retained post-cleanup
|
|
42
|
+
field surface.
|
|
43
|
+
- Cleanup must be idempotent and safe to call multiple times.
|
|
44
|
+
- Use a lock when cleanup can race with active work; check _cleaned before and after locking.
|
|
45
|
+
- Tear down child objects before clearing own fields.
|
|
46
|
+
- Delete owned references after cleanup by default.
|
|
47
|
+
- Logger teardown is always last.
|
|
48
|
+
- Do not rely on GC for owned resources.
|
|
49
|
+
- Document cleanup ordering and ownership in the docstring.
|
|
50
|
+
|
|
51
|
+
Checklist
|
|
52
|
+
- Guard against double cleanup.
|
|
53
|
+
- Acquire lock, then re-check _cleaned.
|
|
54
|
+
- Cleanup children in dependency order.
|
|
55
|
+
- Delete the lock after guarded teardown by default.
|
|
56
|
+
- Delete owned fields explicitly, unless a retained `None` tombstone is part of
|
|
57
|
+
the contract.
|
|
58
|
+
- Logger cleanup last.
|
|
59
|
+
|
|
60
|
+
Example order
|
|
61
|
+
1) if _cleaned: return
|
|
62
|
+
2) with lock: re-check _cleaned, then cleanup children
|
|
63
|
+
3) del self._child
|
|
64
|
+
4) del self._lock
|
|
65
|
+
5) logger.cleanup() (last)
|
|
66
|
+
6) del self._logger
|
|
67
|
+
|
|
68
|
+
Retained-`None` exception example
|
|
69
|
+
1) if callers/tests intentionally read `field` after cleanup:
|
|
70
|
+
2) document that `field` becomes `None`
|
|
71
|
+
3) set `self.field = None` instead of deleting it
|
|
72
|
+
4) keep that exception local and explicit
|
|
73
|
+
|
|
74
|
+
Examples
|
|
75
|
+
- agent_onboarding/user_defined/synaptic_python_developer/examples/python/cleanup_patterns.py
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# comments
|
|
4
|
+
|
|
5
|
+
Purpose
|
|
6
|
+
- Preserve and improve comments as part of the API contract.
|
|
7
|
+
|
|
8
|
+
Prime Directive: Documentation-First Edits
|
|
9
|
+
Whenever you add or modify code:
|
|
10
|
+
* Every class must have a rich docstring.
|
|
11
|
+
* Every method/function must have a rich docstring.
|
|
12
|
+
* Comments must be preserved and improved when they are unclear or insufficient.
|
|
13
|
+
* Treat docstrings + comments as part of the API: they must remain accurate.
|
|
14
|
+
|
|
15
|
+
Non-Negotiables
|
|
16
|
+
* Preserve Documentation and Comments
|
|
17
|
+
* Never delete or strip docstrings.
|
|
18
|
+
* Never delete comments. If a comment is wrong, stale, or misleading, update it rather than removing it.
|
|
19
|
+
* Only rewrite docstrings/comments for code you touched unless an untouched doc/comment is provably wrong or dangerously misleading.
|
|
20
|
+
|
|
21
|
+
Rules
|
|
22
|
+
- Never delete comments; update them if stale or wrong.
|
|
23
|
+
- Add comments only to clarify non-obvious logic.
|
|
24
|
+
- Add moderate, targeted comments for future readers when intent or invariants are not obvious.
|
|
25
|
+
- Avoid narrative or redundant comments.
|
|
26
|
+
- Keep comments aligned with docstrings and invariants.
|
|
27
|
+
- If a comment conflicts with behavior, fix the comment and the code together.
|
|
28
|
+
|
|
29
|
+
Good vs bad
|
|
30
|
+
- Good: "# Guard against re-entrancy during cleanup."
|
|
31
|
+
- Bad: "# Set x to 1." when the code is self-explanatory.
|
|
32
|
+
|
|
33
|
+
Examples
|
|
34
|
+
- agent_onboarding/user_defined/synaptic_python_developer/examples/python/anti_patterns.py
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# docstrings
|
|
4
|
+
|
|
5
|
+
Purpose
|
|
6
|
+
- Ensure docstrings are contract-first, not descriptive fluff.
|
|
7
|
+
|
|
8
|
+
Prime Directive: Documentation-First Edits
|
|
9
|
+
Whenever you add or modify code:
|
|
10
|
+
* Every class must have a rich docstring.
|
|
11
|
+
* Every method/function must have a rich docstring.
|
|
12
|
+
* Comments must be preserved and improved when they are unclear or insufficient.
|
|
13
|
+
* Treat docstrings + comments as part of the API: they must remain accurate.
|
|
14
|
+
|
|
15
|
+
Non-Negotiables
|
|
16
|
+
Rich Docstrings Required (No Fluff)
|
|
17
|
+
This is not optional. For all public classes and public methods, write docstrings that include real contracts, not vibes.
|
|
18
|
+
|
|
19
|
+
Docstring style: follow the repo's existing style (Google / NumPy / reST). If the repo has a pattern, match it exactly.
|
|
20
|
+
|
|
21
|
+
Minimum content for public API:
|
|
22
|
+
* Purpose: what it does and why it exists.
|
|
23
|
+
* Contract: invariants / guarantees / side effects.
|
|
24
|
+
* Parameters: meaning + constraints.
|
|
25
|
+
* Returns: what is returned (or None).
|
|
26
|
+
* Raises: what can be raised, and under what conditions.
|
|
27
|
+
* Threading / Concurrency: locks, thread-safety, reentrancy, ordering (when relevant).
|
|
28
|
+
* Lifecycle / Cleanup: ownership, idempotence, teardown ordering (when relevant).
|
|
29
|
+
* Examples: only when it materially clarifies usage; keep short.
|
|
30
|
+
* Typing: Always add typehints to signatures, and document complex types in the docstring if needed for clarity.
|
|
31
|
+
|
|
32
|
+
No fluff rule: do not write marketing copy or filler sentences. If a docstring is "rich," it's because it contains precise guarantees.
|
|
33
|
+
|
|
34
|
+
Rules
|
|
35
|
+
- Every public class and function must have a rich docstring.
|
|
36
|
+
- Docstrings must be rich and expressive; this is a public repository.
|
|
37
|
+
- Match the repo's prevailing docstring style (Google/NumPy/reST).
|
|
38
|
+
- Include purpose, contract, parameters, returns, raises, threading, and lifecycle when relevant.
|
|
39
|
+
- Keep language precise, stable, and testable.
|
|
40
|
+
- Document ownership and cleanup responsibilities when the code manages resources.
|
|
41
|
+
|
|
42
|
+
Docstring rank ladder (highest to lowest)
|
|
43
|
+
- Rank 5 (Gold): full contract narrative like `normalize_names` in `agent_onboarding/user_defined/synaptic_python_developer/examples/python/docstrings.py`.
|
|
44
|
+
Includes purpose, responsibilities, invariants, workflows, args/returns/raises, and clear
|
|
45
|
+
failure modes with remediation guidance.
|
|
46
|
+
- Rank 4 (Strong): complete args/returns/raises with invariants and side effects, but less
|
|
47
|
+
narrative or fewer workflow details.
|
|
48
|
+
- Rank 3 (Adequate): purpose + args/returns/raises, but missing invariants or error semantics.
|
|
49
|
+
- Rank 2 (Weak): short description with partial args/returns and vague error handling.
|
|
50
|
+
- Rank 1 (Thin): minimal one-liner with no contract detail.
|
|
51
|
+
- Rank 0 (Garbage): no docstring.
|
|
52
|
+
|
|
53
|
+
Comment discipline
|
|
54
|
+
- Comments must explain non-obvious logic and uphold the contract; they are part of the API.
|
|
55
|
+
- Add moderate, targeted comments for future readers when behavior is not obvious from code + docstring alone.
|
|
56
|
+
|
|
57
|
+
Template snippet
|
|
58
|
+
```
|
|
59
|
+
"""
|
|
60
|
+
Purpose: One sentence on what this does and why.
|
|
61
|
+
|
|
62
|
+
Contract:
|
|
63
|
+
- Invariants and guarantees.
|
|
64
|
+
- Side effects and ordering constraints.
|
|
65
|
+
|
|
66
|
+
Args:
|
|
67
|
+
x (Type): Meaning and constraints.
|
|
68
|
+
|
|
69
|
+
Returns:
|
|
70
|
+
Type: What is returned.
|
|
71
|
+
|
|
72
|
+
Raises:
|
|
73
|
+
ValueError: When inputs violate invariants.
|
|
74
|
+
"""
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Good vs bad
|
|
78
|
+
- Good: "Returns a validated FooModel; never mutates inputs."
|
|
79
|
+
- Bad: "Does stuff with foo."
|
|
80
|
+
|
|
81
|
+
Examples
|
|
82
|
+
- agent_onboarding/user_defined/synaptic_python_developer/examples/python/docstrings.py
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# error_model
|
|
4
|
+
|
|
5
|
+
Purpose
|
|
6
|
+
- Keep error behavior explicit and documented.
|
|
7
|
+
|
|
8
|
+
Rules
|
|
9
|
+
- Document raises in docstrings with conditions.
|
|
10
|
+
- Do not swallow exceptions silently.
|
|
11
|
+
- Use clear, stable exception types.
|
|
12
|
+
- Log error context when raising or translating errors.
|
|
13
|
+
- Error messages must be expressive and user-facing: what failed, why, and how to fix.
|
|
14
|
+
- This is a public repo, so raise messages must be safe and explanatory.
|
|
15
|
+
- Use high-quality contract error messages as a reference for detail and remediation.
|
|
16
|
+
- Avoid vague messages like "invalid input" without context.
|
|
17
|
+
|
|
18
|
+
Example
|
|
19
|
+
- Raises: ValueError when input violates invariants.
|
|
20
|
+
- Logging: ERROR with target path, reason, and remediation hint.
|
|
21
|
+
|
|
22
|
+
Examples
|
|
23
|
+
- agent_onboarding/user_defined/synaptic_python_developer/examples/python/docstrings.py
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# hot_path_attribute_aliasing
|
|
4
|
+
|
|
5
|
+
Purpose
|
|
6
|
+
- Apply measured attribute-access rules in Python hot paths.
|
|
7
|
+
|
|
8
|
+
Why this exists
|
|
9
|
+
- Attribute access style can materially affect runtime in tight loops.
|
|
10
|
+
- This skill encodes measured behavior so agents stop guessing and use data.
|
|
11
|
+
|
|
12
|
+
Rules
|
|
13
|
+
- Repeated `self` access in hot loops:
|
|
14
|
+
- Alias once (`local = self._field`) and use the local alias.
|
|
15
|
+
- Method parameter flat access (`param.attr`) in hot loops:
|
|
16
|
+
- Default to direct access.
|
|
17
|
+
- Only alias if a local benchmark for that path shows a win.
|
|
18
|
+
- Method parameter chained access (`param.a.b...`) with depth >= 2 in hot loops:
|
|
19
|
+
- Alias the resolved leaf once and reuse it.
|
|
20
|
+
- Outside hot paths:
|
|
21
|
+
- Prefer readability and avoid unnecessary alias locals.
|
|
22
|
+
|
|
23
|
+
Challenge protocol
|
|
24
|
+
- If an agent disagrees with these rules, they must benchmark and provide evidence.
|
|
25
|
+
- The baseline benchmark files are:
|
|
26
|
+
- `benchmarks/testing_other_di/test_local_alias_vs_direct_attr_perf.py`
|
|
27
|
+
- `context_compass/agent_onboarding/user_defined/synaptic_python_developer/skills/python/attribute_aliasing_skill_benchmark.py`
|
|
28
|
+
|
|
29
|
+
Run commands
|
|
30
|
+
- `python -m pytest benchmarks/testing_other_di/test_local_alias_vs_direct_attr_perf.py -q -s`
|
|
31
|
+
- `python -m pytest context_compass/agent_onboarding/user_defined/synaptic_python_developer/skills/python/attribute_aliasing_skill_benchmark.py -q -s`
|
|
32
|
+
|
|
33
|
+
Evidence reporting format
|
|
34
|
+
- Include one table per scenario:
|
|
35
|
+
- flat `self`
|
|
36
|
+
- flat param
|
|
37
|
+
- chained `self` (depth 2/3/4)
|
|
38
|
+
- chained param (depth 2/3/4)
|
|
39
|
+
- Include:
|
|
40
|
+
- iterations
|
|
41
|
+
- repeats
|
|
42
|
+
- direct ns/iter
|
|
43
|
+
- alias ns/iter
|
|
44
|
+
- alias/direct ratio
|
|
45
|
+
|
|
46
|
+
Decision policy
|
|
47
|
+
- If alias/direct ratio < 1.0: alias is faster.
|
|
48
|
+
- If ratio is near 1.0 (noise band), keep whichever is more readable unless path is proven hot.
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# init_and_ownership
|
|
4
|
+
|
|
5
|
+
Purpose
|
|
6
|
+
- Keep initialization explicit and ownership clear.
|
|
7
|
+
|
|
8
|
+
Constructor / Initialization Requirements
|
|
9
|
+
When adding or modifying __init__ / initialization flows:
|
|
10
|
+
* Maintain explicit ownership: it must be clear what this object owns and what it only references.
|
|
11
|
+
* Initialize fields deterministically and explicitly.
|
|
12
|
+
* If an attribute is optional, initialize it to None (or a clear sentinel) and document that contract.
|
|
13
|
+
|
|
14
|
+
Rules
|
|
15
|
+
- Initialize all attributes deterministically in __init__.
|
|
16
|
+
- Optional fields must be set to None (or a sentinel) and documented.
|
|
17
|
+
- Document ownership: who cleans up what and when.
|
|
18
|
+
- Avoid hidden shared state; prefer instance ownership for resources.
|
|
19
|
+
- If a field is injected and not owned, document that contract explicitly.
|
|
20
|
+
- Dataclasses are value-only: allowed fields are None, bool, int, float, and str.
|
|
21
|
+
- Do not store object instances or resources in dataclasses. If a model needs
|
|
22
|
+
objects or cleanup, use a normal class with cleanup.
|
|
23
|
+
|
|
24
|
+
Checklist
|
|
25
|
+
- Every field is initialized.
|
|
26
|
+
- Ownership and lifecycle are described in the docstring.
|
|
27
|
+
- Optional values are explicitly None.
|
|
28
|
+
|
|
29
|
+
Examples
|
|
30
|
+
- agent_onboarding/user_defined/synaptic_python_developer/examples/python/cleanup_patterns.py
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# interfaces
|
|
4
|
+
|
|
5
|
+
Purpose
|
|
6
|
+
- Choose Protocol, ABC, or concrete types deliberately.
|
|
7
|
+
|
|
8
|
+
Rules
|
|
9
|
+
- Use truthful concrete types plus `typing.TYPE_CHECKING` imports by default
|
|
10
|
+
when the dependency is typing-only.
|
|
11
|
+
- In Python 3.14, deferred annotations are already the default.
|
|
12
|
+
That means the concrete type name should be used directly in annotations
|
|
13
|
+
after a `TYPE_CHECKING` import, with no quotes and no `else: TypeName = Any`
|
|
14
|
+
fallback alias.
|
|
15
|
+
- Use Protocol for structural typing only when multiple implementations are
|
|
16
|
+
expected and the receiving code truly depends on a shared behavioral subset.
|
|
17
|
+
- Use ABC for shared behavior and explicit inheritance requirements.
|
|
18
|
+
- Use concrete types when there is a single stable implementation.
|
|
19
|
+
- For injected object collaborators, default to `TYPE_CHECKING` imports of the
|
|
20
|
+
concrete runtime class unless a real shared structural contract is required.
|
|
21
|
+
- "Injected object collaborator" means an externally supplied object the
|
|
22
|
+
receiver uses or stores but does not construct itself.
|
|
23
|
+
- Use the concrete type when the concrete runtime class is the true contract:
|
|
24
|
+
concrete-only behavior, lifecycle/identity semantics, or intentionally
|
|
25
|
+
concrete public APIs.
|
|
26
|
+
- Document the interface contract in the docstring, not just the type hints.
|
|
27
|
+
- Avoid widening types without a concrete compatibility reason.
|
|
28
|
+
- Interfaces may be exposed in public APIs when they mirror concrete classes.
|
|
29
|
+
If exposed, the runtime object must be the concrete implementation and the
|
|
30
|
+
interface contract must stay in lockstep with it.
|
|
31
|
+
- Prefer `typing.TYPE_CHECKING` over invented structural shims when the problem
|
|
32
|
+
is only import visibility. Reach for interfaces only when the structure
|
|
33
|
+
itself is the contract.
|
|
34
|
+
- Do not widen those truthful concrete types to `Any` just to break an import
|
|
35
|
+
edge. If `Any` appears genuinely unavoidable, raise that conflict to the user
|
|
36
|
+
instead of silently weakening the contract.
|
|
37
|
+
|
|
38
|
+
Example
|
|
39
|
+
- Protocol: "Supports .acquire() and .release()" without forcing inheritance.
|
|
40
|
+
- ABC: "BaseLogger" enforcing cleanup and level setting.
|
|
41
|
+
|
|
42
|
+
Examples
|
|
43
|
+
- agent_onboarding/user_defined/synaptic_python_developer/examples/python/protocols_and_abc.py
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# logging
|
|
4
|
+
|
|
5
|
+
Purpose
|
|
6
|
+
- Ensure consistent logging discipline.
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
No print() - Use the Library's Logging Pattern
|
|
10
|
+
* Do not add print().
|
|
11
|
+
* Use the library's logging abstraction/pattern.
|
|
12
|
+
* If you cannot identify the correct logger usage, ask rather than inventing a new logging style.
|
|
13
|
+
|
|
14
|
+
Rules
|
|
15
|
+
- Never use print().
|
|
16
|
+
- Primary logger path is `InitHelpers.resolve_channel_logger(...)` through the
|
|
17
|
+
hosted provider.
|
|
18
|
+
- Explicit logger objects should be wrapped with
|
|
19
|
+
`InitHelpers.resolve_safe_logger(...)`.
|
|
20
|
+
- Stdlib logging is secondary and should be registered at the provider level as
|
|
21
|
+
the basic fallback only.
|
|
22
|
+
- If logger selection is unclear, raise an explicit open question and cite the
|
|
23
|
+
repository's real logger owner or logger-factory source file.
|
|
24
|
+
|
|
25
|
+
Example
|
|
26
|
+
- logger = InitHelpers.resolve_channel_logger(self, channels="system")
|
|
27
|
+
- logger.info("message", "method_name")
|
|
28
|
+
|
|
29
|
+
Examples
|
|
30
|
+
- agent_onboarding/user_defined/synaptic_python_developer/examples/python/logging_patterns.py
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# module_scope
|
|
4
|
+
|
|
5
|
+
Purpose
|
|
6
|
+
- Prevent hidden shared state and lifecycle confusion.
|
|
7
|
+
|
|
8
|
+
Module Scope: Types + Pure Helpers Only
|
|
9
|
+
* Avoid module-level mutable state (globals, caches, singletons, registries, shared clients).
|
|
10
|
+
* Prefer instance-bound methods/classes for anything with ownership/lifecycle (deps, logging, concurrency, cleanup, configuration).
|
|
11
|
+
* Allowed at module scope:
|
|
12
|
+
* type aliases, Protocols, ABCs, TypeVar/ParamSpec, and other generic definitions
|
|
13
|
+
* pure functions (no side effects, no hidden state, deterministic)
|
|
14
|
+
* Do not add module-level constants or hidden sentinels; define constants on classes/config objects instead.
|
|
15
|
+
* If a helper is not obviously pure/stateless or would introduce shared state, ask first.
|
|
16
|
+
* If an existing module already uses module-level helpers, you may follow the pattern, but do not add new module globals without asking.
|
|
17
|
+
|
|
18
|
+
Rules
|
|
19
|
+
- Avoid module-level mutable state (globals, caches, registries).
|
|
20
|
+
- Module scope is limited to type/generic definitions and pure helper functions.
|
|
21
|
+
- Do not introduce module-level constants; use class attributes or config objects.
|
|
22
|
+
- If a helper is not obviously pure, ask before adding.
|
|
23
|
+
- Prefer instance-owned resources for anything with lifecycle or cleanup.
|
|
24
|
+
|
|
25
|
+
Examples
|
|
26
|
+
- Allowed: ResultT = TypeVar("ResultT")
|
|
27
|
+
- Allowed: class SupportsClose(Protocol): ...
|
|
28
|
+
- Allowed: def normalize_name(value: str) -> str
|
|
29
|
+
- Not allowed: FOO_TIMEOUT_SECONDS = 10 (move to class/config)
|
|
30
|
+
- Not allowed: mutable caches or shared client instances
|
|
31
|
+
|
|
32
|
+
Examples
|
|
33
|
+
- agent_onboarding/user_defined/synaptic_python_developer/examples/python/anti_patterns.py
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# refactor_limits
|
|
4
|
+
|
|
5
|
+
Purpose
|
|
6
|
+
- Keep changes scoped and reviewable.
|
|
7
|
+
|
|
8
|
+
No Drive-By Refactors
|
|
9
|
+
* Do not refactor unrelated code.
|
|
10
|
+
* Do not rename symbols unless explicitly requested.
|
|
11
|
+
* Do not reorder code for aesthetics.
|
|
12
|
+
* Do not reformat files beyond what is required for the change.
|
|
13
|
+
|
|
14
|
+
Reviewability and Change Hygiene
|
|
15
|
+
* Keep changes reviewable.
|
|
16
|
+
* Avoid touching large numbers of files in one change unless explicitly requested.
|
|
17
|
+
* When a large change is required, group it by a clear boundary (module/dir) and apply a consistent rule.
|
|
18
|
+
|
|
19
|
+
Mechanical Sweeps (Repo-Wide Imports / Class Vars / Headers)
|
|
20
|
+
For repo-wide mechanical edits (e.g., "add this import everywhere", "add a class variable to every class"):
|
|
21
|
+
* Prefer generating a deterministic codemod script (or equivalent automated edit) rather than manually editing N files.
|
|
22
|
+
* The codemod must be safe, predictable, and reviewable.
|
|
23
|
+
* The goal is to avoid partial application, missed files, and "creative" edits.
|
|
24
|
+
|
|
25
|
+
Public API Guardrail
|
|
26
|
+
* Do not change public API shape or semantics unless explicitly requested.
|
|
27
|
+
* If a public change is unavoidable, prefer:
|
|
28
|
+
* compatibility adapters/shims, and/or
|
|
29
|
+
* explicit deprecation paths with documentation.
|
|
30
|
+
|
|
31
|
+
Rules
|
|
32
|
+
- No drive-by refactors.
|
|
33
|
+
- No renames or reordering for aesthetics.
|
|
34
|
+
- Group large changes by clear module boundaries.
|
|
35
|
+
- Use codemods for mechanical repo-wide edits.
|
|
36
|
+
- Ask before touching many files or changing public API shape.
|
|
37
|
+
- Preserve existing formatting unless required by the change.
|
|
38
|
+
|
|
39
|
+
Examples
|
|
40
|
+
- agent_onboarding/user_defined/synaptic_python_developer/examples/python/anti_patterns.py
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|