贡献指南

开源地址:PrefEdge , (给点星星鼓励一下吧)。

本项目欢迎各种形式的贡献,包括但不限于:

  • 错误修复 : 修复代码中的错误
  • 功能增强 : 增加新的功能或改进现有功能
  • 文档完善 : 完善项目文档,包括 README、MDX 文档等
  • 架构优化 : 优化项目架构,提高代码的可维护性和可扩展性
  • Issues / Discussions : 报告项目中的问题或建议

贡献流程

  • Fork 本项目
  • 创建新的分支
  • 提交代码
  • 提交 Pull Request
  • 等待项目维护者审核,合并代码

一些规范

代码规范

  • 使用 ES6+ 语法
  • 使用 NextJs 的最佳实践
  • 使用 TypeScript 编写代码
  • 使用 Prettier 格式化代码
  • 使用 ESLint 检查代码质量
  • 正确的使用 Git 提交规范

注意:在提交代码之前,请确保代码已经通过了所有测试和代码质量检查。

文档规范

  • 使用 Markdown 编写文档
  • 使用 MDX 编写文档
  • 如果有本地图片,请尽可能使用 Webp 格式
  • 如果有外部链接,请使用合适的链接格式,标明链接来源