-
Notifications
You must be signed in to change notification settings - Fork 2
Ecc tools/understand quickly 1779240667939 #51
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
0e5dd96
53f5224
0278834
099a5d1
148bb78
dec5e0f
becbdce
dc4eb34
dedc730
1d25533
c3e31c2
4e0b8eb
cc2a486
3f44623
ef3d00b
f3918ea
c72885b
4924a6b
cc24e4f
dbffaf9
6a426ba
6bbb480
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| ```markdown | ||
| # understand-quickly Development Patterns | ||
|
Comment on lines
+1
to
+2
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
The Codex-facing skill is referenced from Useful? React with 👍 / 👎. |
||
|
|
||
| > Auto-generated skill from repository analysis | ||
|
|
||
| ## Overview | ||
| This skill teaches you the core development patterns and conventions used in the `understand-quickly` TypeScript repository. You'll learn about file naming, import/export styles, commit conventions, and how to write and run tests. This guide is ideal for contributors who want to quickly align with the project's established practices. | ||
|
|
||
| ## Coding Conventions | ||
|
|
||
| ### File Naming | ||
| - Use **camelCase** for file names. | ||
| - Example: `myUtility.ts`, `parseData.test.ts` | ||
|
|
||
| ### Import Style | ||
| - Use **relative imports** for referencing local modules. | ||
| - Example: | ||
| ```typescript | ||
| import { parseData } from './parseData'; | ||
| ``` | ||
|
|
||
| ### Export Style | ||
| - Use **named exports** instead of default exports. | ||
| - Example: | ||
| ```typescript | ||
| // In parseData.ts | ||
| export function parseData(input: string): ParsedResult { ... } | ||
| ``` | ||
|
|
||
| ### Commit Message Patterns | ||
| - Mixed commit types, commonly using the `fix` prefix. | ||
| - Average commit message length: ~59 characters. | ||
| - Example: `fix: correct parsing logic for edge cases` | ||
|
|
||
| ## Workflows | ||
|
|
||
| ### Code Contribution | ||
| **Trigger:** When adding or updating features or fixing bugs | ||
| **Command:** `/contribute` | ||
|
|
||
| 1. Create or update files using camelCase naming. | ||
| 2. Use relative imports and named exports in your TypeScript files. | ||
| 3. Write or update corresponding test files using the `*.test.*` pattern. | ||
| 4. Commit changes with a descriptive message, prefixed with the type (e.g., `fix:`). | ||
| 5. Open a pull request for review. | ||
|
|
||
| ### Writing Tests | ||
| **Trigger:** When adding new code or refactoring existing code | ||
| **Command:** `/write-test` | ||
|
|
||
| 1. Create a test file named `yourModule.test.ts` alongside the module. | ||
| 2. Write tests using your preferred testing framework (framework is currently unknown). | ||
| 3. Ensure tests cover all new or changed functionality. | ||
| 4. Run tests locally to verify correctness. | ||
|
|
||
| ### Reviewing Code | ||
| **Trigger:** When reviewing a pull request | ||
| **Command:** `/review` | ||
|
|
||
| 1. Check that file naming, import, and export conventions are followed. | ||
| 2. Verify that commit messages use the correct prefix and are descriptive. | ||
| 3. Ensure all new code is covered by tests in `*.test.*` files. | ||
| 4. Run the test suite to confirm all tests pass. | ||
|
|
||
| ## Testing Patterns | ||
|
|
||
| - Test files follow the `*.test.*` naming convention (e.g., `parseData.test.ts`). | ||
| - The specific testing framework is not detected; use the project's existing test patterns as reference. | ||
| - Place test files alongside the modules they test. | ||
| - Tests should comprehensively cover the logic and edge cases of the module. | ||
|
|
||
| Example: | ||
| ```typescript | ||
| // parseData.test.ts | ||
| import { parseData } from './parseData'; | ||
|
|
||
| describe('parseData', () => { | ||
| it('should parse valid input', () => { | ||
| const result = parseData('input'); | ||
| expect(result).toEqual({ /* expected output */ }); | ||
| }); | ||
| }); | ||
| ``` | ||
|
|
||
| ## Commands | ||
| | Command | Purpose | | ||
| |----------------|----------------------------------------------------| | ||
| | /contribute | Start the code contribution workflow | | ||
| | /write-test | Begin writing or updating tests for your code | | ||
| | /review | Review code for conventions and test coverage | | ||
|
Comment on lines
+85
to
+90
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add blank lines around the commands table. Insert a blank line before and after the table to satisfy markdownlint MD058. 🧰 Tools🪛 markdownlint-cli2 (0.22.1)[warning] 86-86: Tables should be surrounded by blank lines (MD058, blanks-around-tables) [warning] 90-90: Tables should be surrounded by blank lines (MD058, blanks-around-tables) 🤖 Prompt for AI Agents |
||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| interface: | ||
| display_name: "Understand Quickly" | ||
| short_description: "Repo-specific patterns and workflows for understand-quickly" | ||
| default_prompt: "Use the understand-quickly repo skill to follow existing architecture, testing, and workflow conventions." | ||
| policy: | ||
| allow_implicit_invocation: true |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,251 @@ | ||
| { | ||
| "version": "1.3", | ||
| "schemaVersion": "1.0", | ||
| "generatedBy": "ecc-tools", | ||
| "generatedAt": "2026-05-20T01:30:45.793Z", | ||
| "repo": "https://github.com/cryptofixyup/understand-quickly", | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
This generated manifest records the repository as Useful? React with 👍 / 👎. |
||
| "referenceSetReadiness": { | ||
| "score": 0, | ||
| "present": 0, | ||
| "total": 7, | ||
| "items": [ | ||
| { | ||
| "id": "deep-analyzer-corpus", | ||
| "label": "Deep analyzer corpus", | ||
| "status": "missing", | ||
| "evidence": [], | ||
| "recommendation": "Add analyzer fixture, golden, benchmark, or reference-set files that can catch analyzer regressions." | ||
| }, | ||
| { | ||
| "id": "rag-evaluator", | ||
| "label": "RAG/evaluator comparison", | ||
| "status": "missing", | ||
| "evidence": [], | ||
| "recommendation": "Add retrieval or evaluator reference-set comparison fixtures with expected ranking behavior." | ||
| }, | ||
| { | ||
| "id": "pr-salvage", | ||
| "label": "PR salvage/review corpus", | ||
| "status": "missing", | ||
| "evidence": [], | ||
| "recommendation": "Add stale-PR, review-thread, reopen-flow, or salvage reference cases for queue cleanup automation." | ||
| }, | ||
| { | ||
| "id": "discussion-triage", | ||
| "label": "Discussion triage corpus", | ||
| "status": "missing", | ||
| "evidence": [], | ||
| "recommendation": "Add public discussion triage fixtures, golden cases, or reference sets for informational, answered, and no-response classifications." | ||
| }, | ||
| { | ||
| "id": "harness-compatibility", | ||
| "label": "Harness compatibility", | ||
| "status": "missing", | ||
| "evidence": [], | ||
| "recommendation": "Add cross-harness, adapter-compliance, or harness-audit evidence for Claude, Codex, OpenCode, Zed, dmux, and agent surfaces." | ||
| }, | ||
| { | ||
| "id": "security-evidence", | ||
| "label": "Security evidence", | ||
| "status": "missing", | ||
| "evidence": [], | ||
| "recommendation": "Attach security evidence such as SBOMs, SARIF, audit reports, or AgentShield evidence packs." | ||
| }, | ||
| { | ||
| "id": "ci-failure-mode", | ||
| "label": "CI failure-mode evidence", | ||
| "status": "missing", | ||
| "evidence": [], | ||
| "recommendation": "Add captured CI failure logs, dry-run fixtures, or troubleshooting docs for common workflow failure modes." | ||
| } | ||
| ] | ||
| }, | ||
| "profiles": { | ||
| "requested": "security", | ||
| "recommended": "security", | ||
| "effective": "developer", | ||
| "requestedAlias": "security", | ||
| "recommendedAlias": "security", | ||
| "effectiveAlias": "developer" | ||
| }, | ||
| "requestedProfile": "security", | ||
| "profile": "developer", | ||
| "recommendedProfile": "security", | ||
| "effectiveProfile": "developer", | ||
| "tier": "free", | ||
| "requestedComponents": [ | ||
| "repo-baseline", | ||
| "workflow-automation", | ||
| "security-audits" | ||
| ], | ||
| "selectedComponents": [ | ||
| "repo-baseline", | ||
| "workflow-automation" | ||
| ], | ||
| "requestedAddComponents": [], | ||
| "requestedRemoveComponents": [], | ||
| "blockedRemovalComponents": [], | ||
| "tierFilteredComponents": [ | ||
| "security-audits" | ||
| ], | ||
| "requestedRootPackages": [ | ||
| "runtime-core", | ||
| "workflow-pack", | ||
| "agentshield-pack" | ||
| ], | ||
| "selectedRootPackages": [ | ||
| "runtime-core", | ||
| "workflow-pack" | ||
| ], | ||
| "requestedPackages": [ | ||
| "runtime-core", | ||
| "workflow-pack", | ||
| "agentshield-pack" | ||
| ], | ||
| "requestedAddPackages": [], | ||
| "requestedRemovePackages": [], | ||
| "selectedPackages": [ | ||
| "runtime-core", | ||
| "workflow-pack" | ||
| ], | ||
| "packages": [ | ||
| "runtime-core", | ||
| "workflow-pack" | ||
| ], | ||
| "blockedRemovalPackages": [], | ||
| "tierFilteredRootPackages": [ | ||
| "agentshield-pack" | ||
| ], | ||
| "tierFilteredPackages": [ | ||
| "agentshield-pack" | ||
| ], | ||
| "conflictingPackages": [], | ||
| "dependencyGraph": { | ||
| "runtime-core": [], | ||
| "workflow-pack": [ | ||
| "runtime-core" | ||
| ] | ||
| }, | ||
| "resolutionOrder": [ | ||
| "runtime-core", | ||
| "workflow-pack" | ||
| ], | ||
| "requestedModules": [ | ||
| "runtime-core", | ||
| "workflow-pack", | ||
| "agentshield-pack" | ||
| ], | ||
| "selectedModules": [ | ||
| "runtime-core", | ||
| "workflow-pack" | ||
| ], | ||
| "modules": [ | ||
| "runtime-core", | ||
| "workflow-pack" | ||
| ], | ||
| "managedFiles": [ | ||
| ".claude/skills/understand-quickly/SKILL.md", | ||
| ".agents/skills/understand-quickly/SKILL.md", | ||
| ".agents/skills/understand-quickly/agents/openai.yaml", | ||
| ".claude/identity.json", | ||
| ".codex/config.toml", | ||
| ".codex/AGENTS.md", | ||
| ".codex/agents/explorer.toml", | ||
| ".codex/agents/reviewer.toml", | ||
| ".codex/agents/docs-researcher.toml", | ||
| ".claude/homunculus/instincts/inherited/understand-quickly-instincts.yaml" | ||
| ], | ||
| "packageFiles": { | ||
| "runtime-core": [ | ||
| ".claude/skills/understand-quickly/SKILL.md", | ||
| ".agents/skills/understand-quickly/SKILL.md", | ||
| ".agents/skills/understand-quickly/agents/openai.yaml", | ||
| ".claude/identity.json", | ||
| ".codex/config.toml", | ||
| ".codex/AGENTS.md", | ||
| ".codex/agents/explorer.toml", | ||
| ".codex/agents/reviewer.toml", | ||
| ".codex/agents/docs-researcher.toml", | ||
| ".claude/homunculus/instincts/inherited/understand-quickly-instincts.yaml" | ||
| ] | ||
| }, | ||
| "moduleFiles": { | ||
| "runtime-core": [ | ||
| ".claude/skills/understand-quickly/SKILL.md", | ||
| ".agents/skills/understand-quickly/SKILL.md", | ||
| ".agents/skills/understand-quickly/agents/openai.yaml", | ||
| ".claude/identity.json", | ||
| ".codex/config.toml", | ||
| ".codex/AGENTS.md", | ||
| ".codex/agents/explorer.toml", | ||
| ".codex/agents/reviewer.toml", | ||
| ".codex/agents/docs-researcher.toml", | ||
| ".claude/homunculus/instincts/inherited/understand-quickly-instincts.yaml" | ||
| ] | ||
| }, | ||
| "files": [ | ||
| { | ||
| "moduleId": "runtime-core", | ||
| "path": ".claude/skills/understand-quickly/SKILL.md", | ||
| "description": "Repository-specific Claude Code skill generated from git history." | ||
| }, | ||
| { | ||
| "moduleId": "runtime-core", | ||
| "path": ".agents/skills/understand-quickly/SKILL.md", | ||
| "description": "Codex-facing copy of the generated repository skill." | ||
| }, | ||
| { | ||
| "moduleId": "runtime-core", | ||
| "path": ".agents/skills/understand-quickly/agents/openai.yaml", | ||
| "description": "Codex skill metadata so the repo skill appears cleanly in the skill interface." | ||
| }, | ||
| { | ||
| "moduleId": "runtime-core", | ||
| "path": ".claude/identity.json", | ||
| "description": "Suggested identity.json baseline derived from repository conventions." | ||
| }, | ||
| { | ||
| "moduleId": "runtime-core", | ||
| "path": ".codex/config.toml", | ||
| "description": "Repo-local Codex MCP and multi-agent baseline aligned with ECC defaults." | ||
| }, | ||
| { | ||
| "moduleId": "runtime-core", | ||
| "path": ".codex/AGENTS.md", | ||
| "description": "Codex usage guide that points at the generated repo skill and workflow bundle." | ||
| }, | ||
| { | ||
| "moduleId": "runtime-core", | ||
| "path": ".codex/agents/explorer.toml", | ||
| "description": "Read-only explorer role config for Codex multi-agent work." | ||
| }, | ||
| { | ||
| "moduleId": "runtime-core", | ||
| "path": ".codex/agents/reviewer.toml", | ||
| "description": "Read-only reviewer role config focused on correctness and security." | ||
| }, | ||
| { | ||
| "moduleId": "runtime-core", | ||
| "path": ".codex/agents/docs-researcher.toml", | ||
| "description": "Read-only docs researcher role config for API verification." | ||
| }, | ||
| { | ||
| "moduleId": "runtime-core", | ||
| "path": ".claude/homunculus/instincts/inherited/understand-quickly-instincts.yaml", | ||
| "description": "Continuous-learning instincts derived from repository patterns." | ||
| } | ||
| ], | ||
| "workflows": [], | ||
| "adapters": { | ||
| "claudeCode": { | ||
| "skillPath": ".claude/skills/understand-quickly/SKILL.md", | ||
| "identityPath": ".claude/identity.json", | ||
| "commandPaths": [] | ||
| }, | ||
| "codex": { | ||
| "configPath": ".codex/config.toml", | ||
| "agentsGuidePath": ".codex/AGENTS.md", | ||
| "skillPath": ".agents/skills/understand-quickly/SKILL.md" | ||
| } | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix malformed nested fenced code blocks in the skill doc.
The file is wrapped in a top-level code fence (
Line 1toLine 91) while also containing inner fences, which breaks Markdown structure and causes render/lint issues. Remove the outer fence and keep only the inner language-specific examples.Proposed fix
Also applies to: 18-20, 25-28, 73-83, 91-91
🤖 Prompt for AI Agents