mcpField
D
developer-onboarding

developer-onboarding

github.com/aj-geddes开发373474 次安装34 周前更新
代码仓库

关于 developer-onboarding

用于编写开发者入职文档的 Skill，帮助新开发者配置环境、了解代码库并开始贡献。它提供参考指南及项目与开发文档的编写建议。

主要功能

  1. 01开发者入职文档
  2. 02环境配置指南
  3. 03项目结构与架构文档
  4. 04Git、代码风格和测试指南
  5. 05README 与贡献指南

适用场景

  1. 01为新团队成员准备入职材料
  2. 02记录本地开发前置条件
  3. 03编写项目贡献与测试指南

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill developer-onboarding

安装后在 Claude Code 中输入/developer-onboarding确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
available-scripts.md
clone-the-repository.md
code-style.md
database-setup.md
git-workflow.md
project-structure.md
running-tests.md
set-up-environment-variables.md
writing-tests.md
templates/
doc-template.md

详细介绍

开发者入门指南

目录

概述

创建全面的入门文档，帮助新开发者快速搭建开发环境、了解代码库并开始有效地参与贡献。

适用场景

  • 新开发者入门
  • 创建 README 文件
  • 贡献指南
  • 搭建开发环境
  • 架构概览文档
  • 代码风格指南
  • Git 工作流文档
  • 测试指南
  • 部署流程

快速开始

最小可用示例：

# Project Name

Brief project description (1-2 sentences explaining what this project does).

[![Build Status](https://img.shields.io/github/workflow/status/username/repo/CI)](https://github.com/username/repo/actions)
[![Coverage](https://img.shields.io/codecov/c/github/username/repo)](https://codecov.io/gh/username/repo)
[![License](https://img.shields.io/github/license/username/repo)](LICENSE)
[![Version](https://img.shields.io/npm/v/package-name)](https://www.npmjs.com/package/package-name)

## Table of Contents

- [Features](#features)
- [Quick Start](#quick-start)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configuration](#configuration)
- [Development](#development)
- [Testing](#testing)
- [Deployment](#deployment)
- [Architecture](#architecture)
- [Contributing](#contributing)
- [License](#license)

## Features

// ... (see reference guides for full implementation)
```

## Reference Guides

Detailed implementations in the `references/` directory:

| Guide | Contents |
|---|---|
| [Clone the Repository](references/clone-the-repository.md) | Clone the Repository, Install Dependencies |
| [Set Up Environment Variables](references/set-up-environment-variables.md) | Set Up Environment Variables |
| [Database Setup](references/database-setup.md) | Database Setup, Verify Installation |
| [Project Structure](references/project-structure.md) | Project Structure |
| [Available Scripts](references/available-scripts.md) | Available Scripts |
| [Code Style](references/code-style.md) | Code Style |
| [Git Workflow](references/git-workflow.md) | Git Workflow |
| [Running Tests](references/running-tests.md) | Running Tests |
| [Writing Tests](references/writing-tests.md) | Writing Tests |

## Best Practices

### ✅ DO

- Start with a clear, concise project description
- Include badges for build status, coverage, etc.
- Provide a quick start section
- Document all prerequisites clearly
- Include troubleshooting section
- Keep README up-to-date
- Use code examples liberally
- Add architecture diagrams
- Document environment variables
- Include contribution guidelines
- Specify code style requirements
- Document testing procedures

### ❌ DON'T

- Assume prior knowledge
- Skip prerequisite documentation
- Forget to update after major changes
- Use overly technical jargon
- Skip example code
- Ignore Windows/Mac/Linux differences
- Forget to document scripts

评论

支持 Markdown