atchain-mapbox-vue/CONTRIBUTING.md

A Vue 3 MapBox component library with subway lines, stations, markers and polygons support. Zero dependencies except Vue 3 and Mapbox GL JS.

# Contributing to MapBox Vue Components

感谢你对 MapBox Vue Components 的贡献兴趣！

## 🚀 快速开始

### 开发环境要求

- Node.js >= 16.0.0
- npm >= 7.0.0
- Vue 3.x
- TypeScript 4.x+

### 本地开发

1. Fork 并克隆仓库
```bash
git clone https://github.com/your-username/mapbox-vue-components.git
cd mapbox-vue-components
```

2. 安装依赖
```bash
npm install
```

3. 开始开发
```bash
npm run dev
```

## 📝 贡献指南

### 代码规范

- 使用 TypeScript
- 遵循 Vue 3 Composition API 最佳实践
- 保持代码简洁和可读性
- 添加适当的注释和文档

### 提交规范

使用 [Conventional Commits](https://www.conventionalcommits.org/) 格式：

```
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
```

类型包括：
- `feat`: 新功能
- `fix`: 修复 bug
- `docs`: 文档更新
- `style`: 代码格式调整
- `refactor`: 代码重构
- `test`: 测试相关
- `chore`: 构建过程或辅助工具的变动

### Pull Request 流程

1. 创建功能分支
```bash
git checkout -b feature/your-feature-name
```

2. 进行开发并提交
```bash
git add .
git commit -m "feat: add new feature"
```

3. 推送到你的 fork
```bash
git push origin feature/your-feature-name
```

4. 创建 Pull Request

## 🐛 报告 Bug

使用 [GitHub Issues](https://github.com/your-username/mapbox-vue-components/issues) 报告 bug，请包含：

- 详细的问题描述
- 复现步骤
- 预期行为
- 实际行为
- 环境信息（浏览器、Node.js 版本等）
- 相关代码片段或截图

## 💡 功能请求

我们欢迎新功能建议！请通过 Issues 提交功能请求，包含：

- 功能描述
- 使用场景
- 预期的 API 设计
- 是否愿意实现此功能

## 📚 文档贡献

文档改进同样重要：

- 修复错别字或语法错误
- 改进示例代码
- 添加使用案例
- 翻译文档

## 🧪 测试

- 确保所有现有测试通过
- 为新功能添加测试
- 测试覆盖率应保持在合理水平

## 📦 发布流程

维护者负责版本发布：

1. 更新 CHANGELOG.md
2. 更新版本号
3. 创建 Git 标签
4. 发布到 npm

## 🤝 行为准则

请遵循友好、包容的行为准则：

- 尊重所有贡献者
- 建设性的反馈
- 专注于技术讨论
- 帮助新手贡献者

## 📞 联系方式

- GitHub Issues: 技术问题和 bug 报告
- Email: 451591198@qq.com
- 讨论: GitHub Discussions

感谢你的贡献！🎉