贡献指南

贡献者墙

感谢每一位贡献者

您的参与让 ttk file explorer 变得更好！

成为贡献者

1. 提交 PR
   您的 PR 被合并后

2. 加入名单
   成为官方贡献者

3. 展示成就
   列入贡献者墙

贡献方式

• 报告问题或建议
  在 GitHub 创建 Issue · 提供详细描述 · 包含相关环境信息

• 文档贡献
  修改 Markdown 文件 · 更正错误，提升质量 · 更新功能描述和指南

• 代码贡献
  选择现有问题或新功能 · 遵循 PEP8 编码规范 · 创建 Pull Request

• 其他贡献
  即使是小贡献也很重要！任何修正和改进都值得赞赏。

开始步骤

graph LR
  A[Fork 仓库] --> B[克隆仓库]
  B --> C[创建新分支]
  C --> D[编写代码/文档]
  D --> E[提交并推送]
  E --> F[创建 PR]

1. Fork 仓库

   访问 GitHub 仓库并点击Fork按钮

2. 克隆仓库
   

   git clone https://github.com/pyheight/ttk-file-explorer.git
   cd ttk-file-explorer
   

3. 创建新分支
   

   git checkout -b feature/your-feature-name
   

4. 编写代码或文档

   代码修改在src/目录
   文档修改在docs/目录

5. 提交并推送
   

   git add .
   git commit -m "描述您的更改"
   git push origin feature/your-feature-name
   

6. 创建 PR

   在 GitHub 仓库页面点击New Pull Request按钮

贡献规范

• 编码风格
  遵循 PEP8 规范。

• 文档要求
  所有新功能需附带文档。

• 测试要求
  核心功能需包含单元测试。

• 提交信息
  清晰描述变更内容。

更多参考

• 完整贡献指南

• Good First Issues

• 提出任何问题、建议或想法

提示

期待您的贡献！