Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (65 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

94 lines (65 loc) · 2.44 KB

tampermonkey-scripts 贡献指南

你好！我真的很高兴您有兴趣为 tampermonkey-scripts 做出贡献。在提交您的贡献之前，请务必花点时间阅读以下指南：

问题反馈

使用 https://github.com/maomao1996/tampermonkey-scripts/issues/new/choose 创建 issues

项目结构

  • srcipts：项目脚本目录
    • create.js：用于创建新的油猴脚本库
  • packages：油猴脚本目录
  • shared：公共库目录
    • rollup-config：rollup 基础配置
    • tsconfig：tsconfig.json 基础配置
    • types：全局的类型注解（主要为油猴插件的全局方法）
  • greasyfork：修改的第三方库
  • legacy：老版本的脚本目录（可以忽略）

开发环境

在 clone 本仓库后，运行

pnpm i

常用的 NPM 脚本

# 启动开发环境，构建生成 dist-dev
pnpm run dev

# 构建生成 dist
pnpm run build

# 创建新的油猴脚本
pnpm run create-package

CHANGELOG 更新日志规范

在修改了 packages 目录下的代码后，需运行

pnpm run changeset
  1. 选择脚本
  2. feat：选择 minor；其他选 patch

最后在 .changeset 下生成的文件需提交到 git

commit message 规范

git commit message 的格式

<type>(<scope>): <subject>

<body>

<footer>
  • type（必填）：commit 的类型
  • scope（选填）：commit 的影响范围（）
  • subject（必填）：commit 信息的简短描述（50 字以内）

举个 🌰

feat(kill-watermark): 适配腾讯课堂播放页