Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 1.59 KB

如何贡献本项目

实时交流、闲聊 or 长期贡献

建议加入我们的QQ群:StarLocator交流群,在群里你可以得到关于本项目的最新消息,参与长期贡献,或者让我们帮你解决本项目相关的任何问题,包括和群友们闲聊

你甚至可以让我们帮你认识照片上的星星⭐

发现bug?

  1. 请先在 Issues 中搜索是否有人已经提出了相同的问题。
  2. 如果没有,请新建一个 Issue,描述清楚你遇到的问题,我们非常希望你能提供尽可能详细的信息,例如:
    • 详细的问题描述
    • 操作系统(Windows/Linux/MacOS/Android/iOS)
    • 你的浏览器类型及其版本(Chrome/Firefox/Safari/Edge)
    • 按下F12,打开DevTools,显示Console中的报错信息
    • 复现步骤

提交代码

如果你想为本项目贡献代码,你可以按照以下步骤进行:

  1. Fork 本项目,切换到dev分支(我们的主要开发分支)。
  2. 为你的提交创建一个新的分支。
  3. 在新分支上进行你的修改。
  4. 提交你的修改,并新建一个 Pull Request。
  5. 等待我们的 Review。

请尽可能规范你的代码,例如:

  • 使用pnpm format格式化你的代码
  • 使用eslint检查并修复你的代码,例如使用命令pnpm lintfix
  • 尽可能添加详细注释,因为你的代码可能会被其他人阅读和修改
  • 为变量名、函数名等添加有意义的名字

最后

我们诚挚地欢迎你的贡献!