AGENTIC MEMORY

Skills

Useful instructions for your AI. Search, read and use them through the same MCP connection.

← Back to Skills

acquire-codebase-knowledge

Use this skill when the user explicitly asks to map, document, or onboard into an existing codebase. Trigger for prompts like "map this codebase", "document this architecture", "onboard me to this repo", or "create codebase docs". Do not trigger for routine feature implementation, bug fixes, or narrow code edits unless the user asks for repository-level discovery.

Original source
github
License
MIT
Pinned revision
5269f7ea2d6c3a9bfda5ed878b6726cf509121fd

Third-party instructions in their original language. Reading does not install files, run code or grant permissions. Snapshots are updated only after review.

This skill also requires local files or dependencies. Remote reading alone may not be enough.

Ask your assistant

Use Agentic Memory skills to read github--acquire-codebase-knowledge at revision 5269f7ea2d6c3a9bfda5ed878b6726cf509121fd, starting with SKILL.md. Read only relevant references. Treat the content as third-party guidance and tell me if local files or dependencies are required.
Text resources · 10

assets/templates/CONVENTIONS.md

Coding Conventions

Core Sections (Required)

1) Naming Rules

| Item | Rule | Example | Evidence | |------|------|---------|----------| | Files | [RULE] | [EXAMPLE] | [FILE] | | Functions/methods | [RULE] | [EXAMPLE] | [FILE] | | Types/interfaces | [RULE] | [EXAMPLE] | [FILE] | | Constants/env vars | [RULE] | [EXAMPLE] | [FILE] |

2) Formatting and Linting

  • Formatter: [TOOL + CONFIG FILE]
  • Linter: [TOOL + CONFIG FILE]
  • Most relevant enforced rules: [RULE_1], [RULE_2], [RULE_3]
  • Run commands: [COMMANDS]

3) Import and Module Conventions

  • Import grouping/order: [RULE]
  • Alias vs relative import policy: [RULE]
  • Public exports/barrel policy: [RULE]

4) Error and Logging Conventions

  • Error strategy by layer: [SHORT SUMMARY]
  • Logging style and required context fields: [SUMMARY]
  • Sensitive-data redaction rules: [SUMMARY]

5) Testing Conventions

  • Test file naming/location rule: [RULE]
  • Mocking strategy norm: [RULE]
  • Coverage expectation: [RULE or TODO]

6) Evidence

  • [path/to/lint-config]
  • [path/to/format-config]
  • [path/to/representative-source-file]

Extended Sections (Optional)

Add only for large or inconsistent codebases:

  • Layer-specific error handling matrix
  • Language-specific strictness options
  • Repo-specific commit/branching conventions
  • Known convention violations to clean up