欢迎阅读 project_a_forum 的贡献指南!如果你是首次参与开源项目,这里将为你提供清晰的指引。

如何开始?🚀

  1. fork 本仓库 🧾
    在 GitHub 上点击 "Fork" 按钮,获取自己的副本。
  2. 克隆 到本地 🧱
    使用 git clone https://github.com/your_username/project_a_forum.git 获取代码。
  3. 创建分支 🌿
    执行 git checkout -b contribution-guide 开始新功能开发。

代码规范 📐

  • 请遵循 代码风格指南 中的格式要求
  • 使用 Prettier 自动格式化代码 ✅
  • 所有提交需通过 ESLint 检查 🛡️

文档要求 📖

  • 文档需用 Markdown 编写 📄
  • 代码示例需添加注释 📌
  • 请参考 写作规范 优化说明

提交流程 📦

  1. 完成开发后提交代码 git commit -m "feat: add contribution guide"
  2. 推送至你的 fork git push origin contribution-guide
  3. 创建 Pull Request 并选择 "Merge" 模式 🚀

contributing_guide

如需进一步了解项目架构,可查看 项目简介