# 参与贡献

欢迎参与 [sheeridVerify](https://github.com/JenkinWoo/sheeridVerify)，改进教学示例、配置校验、错误处理、任务队列、测试及文档。参与前请阅读 [用途说明与免责声明](DISCLAIMER.md)。

## 开发环境

需要 Node.js >= 22.15 和 npm。在仓库根目录执行：

```bash
npm ci
npm run browser:install
npm test
```

`npm run browser:install` 下载适用于当前系统的 Camoufox，需要网络和相应磁盘空间。未安装浏览器时，依赖浏览器的测试会跳过；涉及浏览器或网页交互的改动应安装浏览器并确认这些用例实际通过。

测试应使用本地页面、模拟接口及虚构测试数据，不访问真实验证接口、不提交真实材料。运行 Web 工作台的准备步骤见 [README](README.md)，Linux 部署见 [部署指南](docs/DEPLOYMENT.md)。

## 报告问题

请提供操作系统、Node.js 版本、可复现步骤、期望和实际行为，以及脱敏后的错误信息。说明使用的是本地运行还是远端部署。不要粘贴完整个人配置、真实验证链接、材料、访问密码、代理凭据或会话信息。

安全漏洞应按 [安全说明](SECURITY.md) 私下报告，不要在公开 Issue 中披露可利用的细节。

## 提交改动

1. 从当前分支创建功能分支，保持一次改动聚焦一个问题。
2. 保持现有 ESM 风格；新增配置项时同时更新示例与文档。
3. 根据改动运行相关测试；涉及任务状态、鉴权和远端写入时覆盖相应行为。
4. 提交前运行 `git diff --check`，确认未纳入本地配置、材料和运行日志。
5. 在 Pull Request 中说明问题、修改后的行为、验证方法及已知限制。

不接受伪造证明、冒用身份、绕过资格审核或未授权访问等方向的功能。贡献者应确保拥有所提交内容的权利；提交的代码按本项目 [ISC 协议](LICENSE) 提供，第三方内容应注明来源及许可。