docs: README.md 及 CONTRIBUTING.md 完善

2023-08-02 18:43:12 +08:00
parent 0db1e5c30b
commit 7cfdbb12a4
2 changed files with 44 additions and 66 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1 +1,36 @@
-敬请期待
+# 贡献指南
+
+感谢您对 Minotaur 项目的兴趣！
+
+欢迎任何人的贡献，无论是新手还是有经验的开发者。以下是一些关于如何开始贡献的指导。
+
+## 开始之前
+
+1. **了解项目**：请先阅读项目的 [README.md](README.md) 和其他文档，了解项目的目的和结构。
+2. **遵循行为准则**：请确保您的贡献符合我们的 [行为准则](CODE_OF_CONDUCT.md)。
+
+## 报告问题
+
+发现了问题或有新的想法？请通过 GitHub Issues 提交。
+
+1. **查找现有问题**：在提交之前，请搜索现有的问题，看看是否有人已经报告了相同的问题。
+2. **提供详细信息**：在报告问题时，请提供尽可能多的详细信息，包括错误消息、操作系统、版本号等。
+
+## 贡献代码
+
+想要为 Minotaur 项目贡献代码？请按照以下步骤操作：
+
+1. **Fork 项目**：点击 GitHub 页面右上角的 "Fork" 按钮。
+2. **克隆您的 Fork**：在您的本地计算机上克隆您的 Fork。
+3. **创建新分支**：为您的修改创建一个新分支。
+4. **提交您的更改**：在新分支上进行修改，并提交您的更改。
+5. **发送 Pull Request**：返回您的 Fork 在 GitHub 上的页面，并点击 "New Pull Request" 按钮。
+
+## 代码风格
+
+请确保您的代码符合项目的编码风格和规范。
+
+## 联系我们
+
+如果您有任何问题或需要帮助，请通过以下方式与我取得联系：
+- 发送电子邮件至：kercylan@gmail.com