README - Common DevX

Last Updated: 2025-10-29 by Keming He

Overview

Ready-to-use templates and AI prompts for consistent documentation, standardized workflows, and faster project setup with zero dependencies. Watch demo on YouTube

Template collection for professional developer experience across any project type.

Directory Structure

common-devx/
├── .github/                # GitHub issue and PR templates
├── guides/                 # Reference guides and tutorials
├── meetings/               # Meeting templates
├── prompts/                # AI workflow prompts
├── troubleshooting/        # Developer issue guides
├── .gitignore              # Extensible ignore rules for OS, IDE, and language-specific files
├── contacts.md             # Team contact template
├── CONTRIBUTING-rebase.md  # Git rebase guide for linear commit history
├── CONTRIBUTING.md         # Contributing guide with conventional commits
├── README-template.md      # Reusable directory README template
├── LICENSE                 # MIT license (exchangeable)
└── README.md               # This file

Quick Links

• .github/ - GitHub issue and PR templates
• guides/README.md - Git operations and workflows
• meetings/README.md - Meeting agendas, memos, and standups
• prompts/README.md - AI-assisted documentation generation
• troubleshooting/README.md - Common development issues
• contacts.md - Team contact information template
• CONTRIBUTING.md - Development workflow and conventions

Getting Started

1. Copy templates: Browse directories and copy .md files to your project

2. Customize content: Replace placeholders with your project details

3. Use AI prompts: Combine prompts with templates for automated generation

Important

Always review AI-generated content for correctness.

References

• MIT License - Free use, modification, and distribution with attribution
• GitHub Issues - Questions, requests, and bug reports
• @KemingHe - Repository maintainer