桌面应用文档【免费下载链接】MarkpadThe Notepad equivalent for Markdown项目地址https://gitcode.com/gh_mirrors/mar/Markpad点击查看免费下载Markpad 是一款基于 Tauri v2 的轻量级 Markdown 查看器与文本编辑器支持 Windows、macOS 和 Linux 三大平台。本文将带你完成 Markpad 开源贡献的完整流程从源码构建这个 Markdown 编辑器到跑通它的双运行器测试体系再到遵循代码规范提交 Pull Request。无论你是第一次接触 Tauri 项目还是想为 Markpad 提交你的第一个 PR这份指南都能让你快速上手。一、先认识 Markpad它用什么构建在贡献代码之前先了解项目的技术构成这决定了你改的是前端、后端还是两者兼顾层次技术说明前端Svelte 5 TypeScript组件、状态管理Runes 语法构建Vite SvelteKit以 SPA 模式运行后端RustTauri v2文件读写等原生能力均以 Tauri 命令暴露编辑器内核Monaco Editor与 VS Code 同款编辑器内置 Vim 支持Markpad 的界面采用编辑 预览双栏布局左栏是 Markdown 源码右栏实时渲染 GitHub 风格的排版效果项目采用 BSD-3-Clause 许可证代码规范与贡献约定都写在仓库根目录的 AGENTS.md 中——这是每位贡献者必读的第一份文档。二、环境准备与克隆仓库5分钟搭好开发环境开发前置条件Node.js 与 npm安装前端依赖并驱动 ViteRust 工具链cargo编译 src-tauri/ 下的后端代码各平台的 Tauri 系统依赖如 Linux 的 WebKitGTKmacOS 的 Xcode 命令行工具克隆仓库并安装依赖git clone https://gitcode.com/gh_mirrors/mar/Markpad cd Markpad npm installnpm install会根据锁文件安装全部依赖。首次启动时Rust 侧会完成一次完整编译耗时较长属正常现象。启动后的首页会展示最近文件列表点击任意文件即可进入编辑三、源码构建记住这几条核心命令构建相关的所有脚本都定义在 package.json 中最常用的有四条# 开发模式热重载窗口即改即见 npm run tauri dev # 生产构建输出可分发的安装包 npm run tauri build # 前端类型检查提交前必跑 npm run check # Rust 侧测试进入后端目录 cd src-tauri cargo test几条实用建议日常开发用npm run tauri devVite 提供毫秒级热更新前端改动几乎即时反映到窗口中npm run check是提交前的底线它运行 svelte-check 做严格模式类型检查CI 会原样执行它若只做 Rust 侧改动cargo build、cargo clippy、cargo fmt分别负责编译检查、静态检查与格式化。编辑器的字体、字号、Vim 模式等选项集中在设置面板中对应的实现位于 src/lib/stores/settings.svelte.ts是理解设置如何驱动界面的好切入点四、项目结构速览代码都在哪里Markpad 的目录职责非常清晰改动前先找对位置src/ lib/ components/ # Svelte 组件Tab、Toc、Editor、Settings 等 stores/ # Svelte 5 响应式状态tabs、settings、update utils/ # 纯逻辑模块scrollSync、foldState、export 等 routes/ # SvelteKit 路由入口 src-tauri/ src/ # Rust 后端Tauri 命令、文件安全、窗口管理 samples/ # 功能示例文档本地验证渲染效果 scripts/ # 全部测试与发布脚本界面组件在 src/lib/components/状态单例在 src/lib/stores/纯逻辑工具约 70 个模块在 src/lib/utils/这里是最容易为新手贡献的领域——逻辑独立、易于测试原生能力文件读写、窗口组织等在 src-tauri/src/所有文件操作必须走 Rust 命令前端不可直接调用 Node 的 fs API。改完渲染功能怎么验证仓库自带一份覆盖全部语法的功能文档 samples/markdown-syntax.md——callout、表格、脚注、KaTeX 公式、Mermaid 图表全在其中用它做回归验证一眼即可确认改对没有。五、测试体系详解三层测试与双运行器的分工Markpad 的测试规模不小仅前端就有 184 个测试文件125 个*.test.ts 59 个*.spec.ts加上 Rust 侧测试共三层防线。一条命令跑三层npm test # 前端逻辑测试node --test npm run test:vitest # 前端组件/Runes 模块测试vitest jsdom cd src-tauri cargo test # Rust 后端测试双运行器为什么分家这是贡献前必须理解的关键设计约定见 AGENTS.md 的 Testing 章节运行器匹配文件适用对象node --testscripts/*.test.ts纯 TypeScript 逻辑模块vitestscripts/*.spec.ts.svelte.tsRunes 模块、需要真实 DOM 的场景两个 glob互不重叠一个文件只属于一个运行器移动文件即改后缀重命名被测对象是 Runes 状态模块$state/$derived/$effect或需要 DOM 时**必须写成*.spec.ts** 交给 vitest因为node --test 无法真正编译执行 Runesvitest 侧有一个关键配置vitest.config.ts 中的resolve.conditions: [browser]。缺了它Svelte 会解析到 SSR 构建$effect永不刷新测试会假绿。测试的两种断言风格除行为测试import 真实模块并执行外仓库还大量使用源码形态断言直接匹配源码文本来守护编译器检查不了的契约例如 Tauri 命令名、i18n 键、某行为只存在唯一一份实现。这类断言只要被守护的那行源码拼写不变就会通过——理解这一点才不会误改触发失败的源码行。CI 会检查什么Pull Request 会自动运行npm audit、npm run check、npm test、npm run test:vitest与cargo test。建议提交前在本地原样跑一遍这五条命令避免 PR 红灯。六、代码风格规范让 PR 一次通过TypeScript / Svelte缩进使用 Tab字符串用单引号响应式一律使用 Svelte 5 Runes$state()、$derived()、$effect()、$props()组件命名 PascalCase状态模块用.svelte.ts扩展名并导出单例。Rust4 空格缩进函数变量用 snake_case类型用 PascalCaseTauri 命令统一标注#[tauri::command]并返回ResultT, String平台差异用#[cfg(target_os …)]条件编译处理。版本号必须三处同步改版本号时package.json、src-tauri/Cargo.toml 与Cargo.lock三处必须一致否则自动更新插件无法正确比较版本。正确姿势是运行npm run release X.Y.Z它会写齐三处文件并校验一致性而 scripts/versionSync.test.ts 会在测试中持续守护这个约定。七、从 PR 到发布你的代码将经历什么提交 PR 后CI 的五项检查全部通过即可等待合并。而当一个版本真正发布时维护者会执行 RELEASING.md 中的发布手册npm run release X.Y.Z同步三处版本号提交、打 tag 并推送触发跨 macOS / Windows / Linux 的构建矩阵构建产物经 minisign 签名生成latest.json更新源用户端检查更新即从此处拉取发布后自动向 Chocolatey 与 Snap 商店推送对应渠道包。了解这套流程有助于你理解仓库里那些看似奇特的守护测试如 scripts/releaseWorkflow.test.ts存在的理由。新手贡献路线图 按这个顺序推进阻力最小跑起来npm run tauri dev启动开发窗口随手改一处文案并保存观察热重载报一个 Bug在 Issue 区复现并描述清楚好 PR 往往始于好 Issue从 utils 入手选一个 src/lib/utils/ 中的纯逻辑模块修 Bug 或补功能它通常只需要*.test.ts一层测试全绿再提交本地跑通npm run checknpm testnpm run test:vitestcargo test再开 PR。Markpad 的文档 README.zh-CN.md 与 AGENTS.md 会随项目演进持续更新。祝你的第一个贡献顺利合入赞分享桌面应用文档【免费下载链接】MarkpadThe Notepad equivalent for Markdown项目地址https://gitcode.com/gh_mirrors/mar/Markpad点击查看免费下载相关推荐如何为Carthage贡献代码源码构建、Xcode调试与测试体系开发者指南如何为Carthage贡献代码源码构建、Xcode调试与测试体系开发者指南 Carthage 是一个著名的 Cocoa 去中心化依赖管理器它通过构建二进制框开发工具如何参与MoviePy开源贡献从环境搭建到运行测试的开发者指南如何参与MoviePy开源贡献从环境搭建到运行测试的开发者指南 MoviePy视频编辑 with Python是一个用 Python 进行视频剪辑的开源库音视频视频处理音频处理如何给waitForImages开源项目贡献代码从Grunt构建到QUnit测试的完整开发者流程如何给waitForImages开源项目贡献代码从Grunt构建到QUnit测试的完整开发者流程 waitForImages 是一个 jQuery 图片加载插前端创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 
长河君 · 2026/10/14 16:09:05 · 阅读 1.2k 如何参与Markpad开源贡献：从源码构建到测试体系的开发者完整指南
桌面应用文档【免费下载链接】MarkpadThe Notepad equivalent for Markdown项目地址https://gitcode.com/gh_mirrors/mar/Markpad点击查看免费下载Markpad 是一款基于 Tauri v2 的轻量级 Markdown 查看器与文本编辑器支持 Windows、macOS 和 Linux 三大平台。本文将带你完成 Markpad 开源贡献的完整流程从源码构建这个 Markdown 编辑器到跑通它的双运行器测试体系再到遵循代码规范提交 Pull Request。无论你是第一次接触 Tauri 项目还是想为 Markpad 提交你的第一个 PR这份指南都能让你快速上手。一、先认识 Markpad它用什么构建在贡献代码之前先了解项目的技术构成这决定了你改的是前端、后端还是两者兼顾层次技术说明前端Svelte 5 TypeScript组件、状态管理Runes 语法构建Vite SvelteKit以 SPA 模式运行后端RustTauri v2文件读写等原生能力均以 Tauri 命令暴露编辑器内核Monaco Editor与 VS Code 同款编辑器内置 Vim 支持Markpad 的界面采用编辑 预览双栏布局左栏是 Markdown 源码右栏实时渲染 GitHub 风格的排版效果项目采用 BSD-3-Clause 许可证代码规范与贡献约定都写在仓库根目录的 AGENTS.md 中——这是每位贡献者必读的第一份文档。二、环境准备与克隆仓库5分钟搭好开发环境开发前置条件Node.js 与 npm安装前端依赖并驱动 ViteRust 工具链cargo编译 src-tauri/ 下的后端代码各平台的 Tauri 系统依赖如 Linux 的 WebKitGTKmacOS 的 Xcode 命令行工具克隆仓库并安装依赖git clone https://gitcode.com/gh_mirrors/mar/Markpad cd Markpad npm installnpm install会根据锁文件安装全部依赖。首次启动时Rust 侧会完成一次完整编译耗时较长属正常现象。启动后的首页会展示最近文件列表点击任意文件即可进入编辑三、源码构建记住这几条核心命令构建相关的所有脚本都定义在 package.json 中最常用的有四条# 开发模式热重载窗口即改即见 npm run tauri dev # 生产构建输出可分发的安装包 npm run tauri build # 前端类型检查提交前必跑 npm run check # Rust 侧测试进入后端目录 cd src-tauri cargo test几条实用建议日常开发用npm run tauri devVite 提供毫秒级热更新前端改动几乎即时反映到窗口中npm run check是提交前的底线它运行 svelte-check 做严格模式类型检查CI 会原样执行它若只做 Rust 侧改动cargo build、cargo clippy、cargo fmt分别负责编译检查、静态检查与格式化。编辑器的字体、字号、Vim 模式等选项集中在设置面板中对应的实现位于 src/lib/stores/settings.svelte.ts是理解设置如何驱动界面的好切入点四、项目结构速览代码都在哪里Markpad 的目录职责非常清晰改动前先找对位置src/ lib/ components/ # Svelte 组件Tab、Toc、Editor、Settings 等 stores/ # Svelte 5 响应式状态tabs、settings、update utils/ # 纯逻辑模块scrollSync、foldState、export 等 routes/ # SvelteKit 路由入口 src-tauri/ src/ # Rust 后端Tauri 命令、文件安全、窗口管理 samples/ # 功能示例文档本地验证渲染效果 scripts/ # 全部测试与发布脚本界面组件在 src/lib/components/状态单例在 src/lib/stores/纯逻辑工具约 70 个模块在 src/lib/utils/这里是最容易为新手贡献的领域——逻辑独立、易于测试原生能力文件读写、窗口组织等在 src-tauri/src/所有文件操作必须走 Rust 命令前端不可直接调用 Node 的 fs API。改完渲染功能怎么验证仓库自带一份覆盖全部语法的功能文档 samples/markdown-syntax.md——callout、表格、脚注、KaTeX 公式、Mermaid 图表全在其中用它做回归验证一眼即可确认改对没有。五、测试体系详解三层测试与双运行器的分工Markpad 的测试规模不小仅前端就有 184 个测试文件125 个*.test.ts 59 个*.spec.ts加上 Rust 侧测试共三层防线。一条命令跑三层npm test # 前端逻辑测试node --test npm run test:vitest # 前端组件/Runes 模块测试vitest jsdom cd src-tauri cargo test # Rust 后端测试双运行器为什么分家这是贡献前必须理解的关键设计约定见 AGENTS.md 的 Testing 章节运行器匹配文件适用对象node --testscripts/*.test.ts纯 TypeScript 逻辑模块vitestscripts/*.spec.ts.svelte.tsRunes 模块、需要真实 DOM 的场景两个 glob互不重叠一个文件只属于一个运行器移动文件即改后缀重命名被测对象是 Runes 状态模块$state/$derived/$effect或需要 DOM 时**必须写成*.spec.ts** 交给 vitest因为node --test 无法真正编译执行 Runesvitest 侧有一个关键配置vitest.config.ts 中的resolve.conditions: [browser]。缺了它Svelte 会解析到 SSR 构建$effect永不刷新测试会假绿。测试的两种断言风格除行为测试import 真实模块并执行外仓库还大量使用源码形态断言直接匹配源码文本来守护编译器检查不了的契约例如 Tauri 命令名、i18n 键、某行为只存在唯一一份实现。这类断言只要被守护的那行源码拼写不变就会通过——理解这一点才不会误改触发失败的源码行。CI 会检查什么Pull Request 会自动运行npm audit、npm run check、npm test、npm run test:vitest与cargo test。建议提交前在本地原样跑一遍这五条命令避免 PR 红灯。六、代码风格规范让 PR 一次通过TypeScript / Svelte缩进使用 Tab字符串用单引号响应式一律使用 Svelte 5 Runes$state()、$derived()、$effect()、$props()组件命名 PascalCase状态模块用.svelte.ts扩展名并导出单例。Rust4 空格缩进函数变量用 snake_case类型用 PascalCaseTauri 命令统一标注#[tauri::command]并返回ResultT, String平台差异用#[cfg(target_os …)]条件编译处理。版本号必须三处同步改版本号时package.json、src-tauri/Cargo.toml 与Cargo.lock三处必须一致否则自动更新插件无法正确比较版本。正确姿势是运行npm run release X.Y.Z它会写齐三处文件并校验一致性而 scripts/versionSync.test.ts 会在测试中持续守护这个约定。七、从 PR 到发布你的代码将经历什么提交 PR 后CI 的五项检查全部通过即可等待合并。而当一个版本真正发布时维护者会执行 RELEASING.md 中的发布手册npm run release X.Y.Z同步三处版本号提交、打 tag 并推送触发跨 macOS / Windows / Linux 的构建矩阵构建产物经 minisign 签名生成latest.json更新源用户端检查更新即从此处拉取发布后自动向 Chocolatey 与 Snap 商店推送对应渠道包。了解这套流程有助于你理解仓库里那些看似奇特的守护测试如 scripts/releaseWorkflow.test.ts存在的理由。新手贡献路线图 按这个顺序推进阻力最小跑起来npm run tauri dev启动开发窗口随手改一处文案并保存观察热重载报一个 Bug在 Issue 区复现并描述清楚好 PR 往往始于好 Issue从 utils 入手选一个 src/lib/utils/ 中的纯逻辑模块修 Bug 或补功能它通常只需要*.test.ts一层测试全绿再提交本地跑通npm run checknpm testnpm run test:vitestcargo test再开 PR。Markpad 的文档 README.zh-CN.md 与 AGENTS.md 会随项目演进持续更新。祝你的第一个贡献顺利合入赞分享桌面应用文档【免费下载链接】MarkpadThe Notepad equivalent for Markdown项目地址https://gitcode.com/gh_mirrors/mar/Markpad点击查看免费下载相关推荐如何为Carthage贡献代码源码构建、Xcode调试与测试体系开发者指南如何为Carthage贡献代码源码构建、Xcode调试与测试体系开发者指南 Carthage 是一个著名的 Cocoa 去中心化依赖管理器它通过构建二进制框开发工具如何参与MoviePy开源贡献从环境搭建到运行测试的开发者指南如何参与MoviePy开源贡献从环境搭建到运行测试的开发者指南 MoviePy视频编辑 with Python是一个用 Python 进行视频剪辑的开源库音视频视频处理音频处理如何给waitForImages开源项目贡献代码从Grunt构建到QUnit测试的完整开发者流程如何给waitForImages开源项目贡献代码从Grunt构建到QUnit测试的完整开发者流程 waitForImages 是一个 jQuery 图片加载插前端创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考