我们非常感谢你为 ScriptCat 做出贡献!本指南旨在帮助你以更规范的方式向 ScriptCat 提交贡献,因此请务必认真阅读。
在提交 Issue 前,我们建议你先查看 已有的 Issues,以避免重复提交。
ScriptCat 是一个不断发展的项目。如果你在使用过程中发现问题,并且确信这些问题是由 ScriptCat 引起的,欢迎提交 Issue。在提交时,请附带详细的复现步骤和运行环境信息。
我们欢迎你在 Issue 中提出新的功能建议。为了让我们更好地理解你的需求,建议你尽可能详细地描述这个功能,并提供你认为可能的解决方案。
ScriptCat 使用 npm 来管理项目依赖。如果你已经安装了 npm,以下的命令可以帮助你快速配置开发环境:
# 安装 node.js 依赖
npm install
我们推荐使用代理来解决 npm 的网络问题,而不是使用镜像。
# 设置代理
npm config set proxy=http://127.0.0.1:1080
我们希望每一个 commit 都能清晰地描述其目的,每个 commit 应尽可能只包含一个修改。我们的 commit message 格式遵循 gitmoji 规范。例如:
git commit -m "✨ add login feature"
这个示例表示添加了新的功能:登录功能。
main
分支是 ScriptCat 的主分支。为了保持代码的完整性,请不要直接修改 main
分支。你应该创建一个新的分支,并在这个分支上进行修改,然后发起一个目标分支为
main
的 Pull Request。Pull Request
的标题请尽量使用中文,以便于自动生成更新日志。
如果你不是 ScriptCat 团队的成员,你可以先 fork 本仓库,然后向本仓库的 main
分支发起 Pull Request。在创建 commit 时,请按照上述 commit message
规范进行。我们将在 code review 完成后将你的贡献合并到主分支。
ScriptCat 的文档在另外的仓库中:scriptcat.org,使用 docusaurus进行撰写,这有一些 [Markdown](https://docusaurus.io/
zh-CN/docs/markdown-features) 特性可以帮助你。如果你需要在本地预览修改后的文档,可以使用以下命令安装文档依赖并启动 dev server:
npm install
npm start
ScriptCat 使用 ESLint 来规范代码风格,使用 Jest 来进行单元测试。你可以使用以下命令来运行:
npm test
npm run lint
ScriptCat 的页面开发使用了以下技术:
如果你想在本地运行 ScriptCat,可以使用以下命令:
npm run dev
如果你想打包扩展,可以使用以下命令:
npm run pack
在打包前,请确保在dist
目录下生成了scriptcat.pem
文件。