{"id":29415128,"url":"https://github.com/keminghe/common-devx","last_synced_at":"2026-02-05T18:31:33.285Z","repository":{"id":303883083,"uuid":"1016979259","full_name":"KemingHe/common-devx","owner":"KemingHe","description":"Ready-to-use templates and AI prompts for consistent documentation, standardized workflows, and faster project setup with zero dependencies","archived":false,"fork":false,"pushed_at":"2025-12-25T20:25:23.000Z","size":73,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-05T11:51:50.511Z","etag":null,"topics":["ai-assisted-development","documentation","prompt-engineering","template"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KemingHe.png","metadata":{"files":{"readme":"README-template.md","changelog":null,"contributing":"CONTRIBUTING-rebase.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":".github/NOTICE.md","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-09T20:42:07.000Z","updated_at":"2025-12-25T20:25:26.000Z","dependencies_parsed_at":"2025-07-10T08:52:40.181Z","dependency_job_id":"960370d1-cd37-4a7e-8f0d-c94dcab8b4b4","html_url":"https://github.com/KemingHe/common-devx","commit_stats":null,"previous_names":["keminghe/common-devx"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/KemingHe/common-devx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KemingHe%2Fcommon-devx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KemingHe%2Fcommon-devx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KemingHe%2Fcommon-devx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KemingHe%2Fcommon-devx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KemingHe","download_url":"https://codeload.github.com/KemingHe/common-devx/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KemingHe%2Fcommon-devx/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29128696,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-05T18:31:02.507Z","status":"ssl_error","status_checked_at":"2026-02-05T18:29:43.962Z","response_time":65,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-assisted-development","documentation","prompt-engineering","template"],"created_at":"2025-07-11T15:45:04.488Z","updated_at":"2026-02-05T18:31:33.273Z","avatar_url":"https://github.com/KemingHe.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# README - [DIRECTORY_NAME]\n\n\u003c!--\nAI AGENT INSTRUCTIONS FOR ADAPTING THIS TEMPLATE:\n\n## ROLE\nYou are a technical documentation specialist creating domain-specific README files for software projects.\n\n## GIT OPERATIONS (Read-Only)\n\n**Setup**: Always `cd /path/to/repository` first, then pipe commands to `cat` to avoid interactive mode.\n\n**Safe Commands**:\n```shell\ngit status | cat                    # Current state\ngit diff | cat                      # Unstaged changes\ngit diff --staged | cat             # Staged changes\ngit log --oneline -10 | cat         # Recent commits\ngit branch -a | cat                 # All branches\ngit remote -v | cat                 # Remote configuration\ngit ls-files | cat                  # Tracked files\n```\n\n**Forbidden Operations**: Never use git commit, push, pull, merge, rebase, add, reset --hard, clean, or stash.\n\n**Prefer Remote Tools**: Use GitHub/GitLab MCP tools when available for issues, PRs, and remote state inspection.\n\n## ADAPTATION PROCESS\n\n### STEP 1: Understand Repository Context\n- **Navigate and discover**: Use git operations above to understand project state\n- **Read documentation**: Root README.md, parent README.md (if nested), sibling READMEs\n- **Identify domain**: What is this directory's specific purpose and where does it fit?\n\n### STEP 2: Analyze This Directory Only (Non-Recursive)\n- List files and immediate subdirectories at THIS level only\n- Identify primary purpose: What problem does THIS directory solve?\n- Determine type: operational code, documentation, tooling, archived material\n- Check for status: Active, Legacy, Archived, In Development\n\n### STEP 3: Write Metadata \u0026 Overview\n- Replace [DIRECTORY_NAME] with actual name (preserve Title Case or kebab-case)\n- Update \"Last Updated\" to current date (YYYY-MM-DD format)\n- Write 1-2 sentence summary: \"What does THIS directory contain and why?\"\n- Add status if applicable: (Active) | (Legacy) | (Archived) | (In Development)\n\n### STEP 4: Build Directory Tree (This Level Only)\nList only immediate children with purpose comments. Do NOT recurse into subdirectories.\n\n**Good** (purpose-focused, refers to subdirectory READMEs):\n```text\nfeature-module/\n├── components/           # UI components (see components/README.md)\n├── utils/                # Helper utilities (see utils/README.md)\n├── index.ts              # Module entry point and exports\n└── README.md             # This file\n```\n\n**Bad** (too detailed, documents subdirectory internals):\n```text\nfeature-module/\n├── components/\n│   ├── Button.tsx        # Button component with...\n│   └── Input.tsx         # Input component with...\n```\n\n### STEP 5: Add Navigation \u0026 Reference Sections\n\n**Quick Links** (required):\n- Format: `[file/path](link) - Brief description`\n- Link to README.md files: `[Dir](../dir/README.md)` not ~~`../dir/`~~\n- Include guides/workflows relevant to this directory\n- Include key entry-point files\n\n**Prerequisites** (operational directories only):\n- Format: `**Tool/Item** requirement - See [guide](link)`\n- Tools with versions, required access/credentials (3-5 items max)\n- Link to setup guides, never duplicate installation steps\n\n**Getting Started** (operational directories only):\n- Format: `**Action name**: Description - See [guide](link)`\n- 3-5 steps for most common use case\n- Link to comprehensive guides, don't duplicate them\n\n**References** (required):\n- Format: `[file/resource](link) - Brief description`\n- Links to related READMEs and docs NOT already mentioned above\n- 2-3 external resources maximum\n\n## CONSTRAINTS - KISS \u0026 DRY\n\n### Purpose\nREADMEs are for **onboarding** (what is this?), **navigation** (where to find details), and **context** (why it exists). NOT for tutorials, API docs, or duplicating other files.\n\n### Length and Scannability\n- **Target**: ~50 lines, maximum 100 lines\n- **Reading time**: Under 1 minute (quick scan should reveal directory purpose)\n- **If exceeding 100 lines**: Directory may be too complex - prompt developer to consider breaking into subdomain directories with their own READMEs\n\n### Domain Separation\nEach README documents ONLY its level. Parent mentions children exist and links to their READMEs. NO overlap.\n\n### Eliminate Redundancy\n- Directory tree has inline comments? Don't repeat in \"Key Files\" table\n- External resource mentioned inline? Don't repeat in References\n- Covered in Quick Links? Don't repeat in Getting Started\n- **Rule**: Say it once, say it well, link to it elsewhere\n\n### Always Link to README.md\nUse `[Dir](../dir/README.md)` not ~~`../dir/`~~ so users land on documentation, not file listings.\n\n## SECTION REQUIREMENTS\n\n**Required** (all READMEs):\n1. Title with metadata (date, author)\n2. Overview (1-2 sentences + optional status)\n3. Directory Structure (this level only, with purpose comments)\n4. Quick Links (to READMEs and key docs)\n5. References (non-redundant links only)\n\n**Conditional** (operational directories only):\n- Prerequisites (tools/access, 3-5 items, link to setup guides)\n- Getting Started (3-5 steps for common use case, link to comprehensive guides)\n\nDELETE THIS ENTIRE COMMENT BLOCK when generating the actual README.\n--\u003e\n\n\u003e **Last Updated**: YYYY-MM-DD by [First Name Last Name]\n\n## Overview\n\n[1-2 sentence executive summary: What does this directory contain and why does it exist?]\n\n[Optional status indicator: (Active) | (Legacy) | (Archived) | (In Development)]\n\n## Directory Structure\n\n```text\n[directory-name]/\n├── [file.ext]            # Brief purpose description\n├── [subdir1]/            # Brief purpose - See subdir1/README.md for details\n├── [subdir2]/            # Brief purpose - See subdir2/README.md for details  \n└── README.md             # This file\n```\n\n\u003c!-- \nIMPORTANT: Only list items at THIS level. Do NOT drill into subdirectories.\nTheir contents are documented in their own README.md files.\n--\u003e\n\n## Quick Links\n\n- [`../docs/guide.md`](../docs/guide.md) - Related workflow or guide\n- [`../other-dir/README.md`](../other-dir/README.md) - Related directory documentation\n- [`./subdir/README.md`](./subdir/README.md) - Subdirectory details\n\n\u003c!-- DELETE Prerequisites and Getting Started sections if NOT an operational directory --\u003e\n\n## Prerequisites\n\n\u003c!-- INCLUDE only for operational directories (code, scripts, configs) --\u003e\n\u003c!-- OMIT for pure documentation or archived directories --\u003e\n\n- **Tool Name** \u003e= version - See [`setup-guide.md`](../docs/setup-guide.md)\n- **Access/Credential** required - See [`access-guide.md`](../docs/access-guide.md)\n- **Prior Setup** - See [`prerequisite-workflow.md`](../docs/prerequisite-workflow.md)\n\n## Getting Started\n\n\u003c!-- INCLUDE only for directories where users execute commands/workflows --\u003e\n\u003c!-- OMIT for pure documentation, archived, or reference directories --\u003e\n\u003c!-- Focus on THE MOST COMMON use case only --\u003e\n\n1. **Action name**: Brief description\n\n   ```shell\n   command-example\n   ```\n\n2. **Action name**: Brief description - See [`detailed-guide.md`](../docs/detailed-guide.md)\n\n3. **Action name**: Brief description\n\nFor complete workflows, see:\n\n- [`comprehensive-workflow.md`](../docs/comprehensive-workflow.md)\n\n## References\n\n\u003c!-- Link to README.md files and essential docs NOT already mentioned above --\u003e\n\u003c!-- Do NOT repeat links from Quick Links or Getting Started --\u003e\n\n- [`../related-dir/README.md`](../related-dir/README.md) - Related directory documentation\n- [`../docs/decision.md`](../docs/decision.md) - Decision rationale or guide\n- [External resource](https://url.com) - When to use this resource\n\n\u003e README Template v1.0.3 - KemingHe/common-devx\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeminghe%2Fcommon-devx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeminghe%2Fcommon-devx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeminghe%2Fcommon-devx/lists"}