AI-native knowledge base & Evernote/Obsidian alternative with instant sync & native MCP. Free on Cloudflare or self-hosted via Docker.
HTML ai-agentcloudflarecloudflare-d1cloudflare-r2cloudflare-workersdockerelectronevernoteevernote-alternativeknowledge-basemcpnote-takingobsidian-alternativeoffline-firstpersonal-knowledge-basepwaself-hostedsqlitetiptapweb-clipper
docs: clarify release contributor credits and simplify guidance
tianma-if7b2fce158de5
diff --git a/AGENTS.md b/AGENTS.mdindex 31df59a9..e61276a1 100644--- a/AGENTS.md+++ b/AGENTS.md@@ -52,6 +52,8 @@Related Issue: #<issue-number>```+12. **外部贡献者署名**:维护者本人无需署名;外部贡献逐条注明账号与 PR,或集中致谢。正文名单不重复列名,保留 GitHub 原生 Contributors 头像区。参数用法见 `docs/release.zh-CN.md` / `docs/release.md`。+## 环境、部署与组件约束- **Cloudflare 部署**:严格按 `docs/agent-deploy-cloudflare.md` 执行。diff --git a/docs/release.md b/docs/release.mdindex edc2ca5d..32a32ca1 100644--- a/docs/release.md+++ b/docs/release.md@@ -37,36 +37,24 @@ non-user-facing commit with a concrete reason:--ignore-commit "89abcde:test-only coverage"```-The coverage audit runs before any local or GitHub mutation. Its mapping is-stored in the tracking Issue, not in the public Release notes. Public notes-contain user-visible changes, impact, necessary migration guidance, and optional-contributor acknowledgments.+The coverage audit runs before any local or GitHub mutation; its mapping is+stored in the tracking Issue. Use `--dry-run` to preview commit coverage, the+native rebuild plan, and Release notes.-To thank contributors to this version, optionally append one `--contributor`-per GitHub username to the release command:+### External Contributor Credits-```bash---contributor alice --contributor "@bob"-```+- Changes completed by the maintainer need no attribution. Credit external+ contributions with `@username` and the PR at the end of the corresponding item.+- Multiple contributions by the same person may use consolidated credits instead.+ The closing list only includes people not credited individually; omit it when empty.+- GitHub generates its native Contributors avatar section from `@username`+ mentions throughout the notes, including individual items.-Review the list before publishing. Include code, translation, documentation, or-issue-reporting contributions that helped this version; omit bots and avoid-repeating the maintainer by default. Usernames may include a leading `@` and-are deduplicated without regard to case, preserving the first spelling and order.-The script appends `贡献者 / Contributors:@alice @bob` after the bilingual notes;-omitting the option leaves the notes unchanged. GitHub uses the mentions to-display its native Contributors avatar list. No accounts are inferred from commits-or checked against GitHub. Preview the text with `--dry-run`. Resuming an existing-Draft preserves its notes; edit that Draft directly if its acknowledgments need-correction before publishing.--Use `--dry-run` to inspect commit coverage, the native rebuild plan, and notes.-After publication, the command does not download, install, or launch the macOS-application. Existing macOS, Windows, and Linux installations receive new-versions through the in-app automatic updater. Linux Preview releases must pass-a real AppImage-to-AppImage transition through the cross-version gate. Pass-`--install-desktop` explicitly only when the previous installation check is-actually needed.+Place individual credits in `--change-zh` / `--change-en`. For a consolidated+list, repeat `--contributor alice`; the script appends+`贡献者 / Contributors:@alice` after the bilingual notes. This option does not+infer contributors automatically. Resuming an existing Draft preserves its+notes; edit the Draft directly to adjust credits.## EdgeEver-Specific Behavior@@ -87,8 +75,8 @@ actually needed.- The script creates the tracking Issue and Draft Release, validates or reusesnative assets, prepares and audits the multi-platform GHCR image, publishes,and closes the Issue without installing- the desktop application by default; installation remains available as an- explicit option.+ the desktop application by default; installation checks require an explicit+ `--install-desktop`.Demo deployment continues independently after its Actions URL is printed.- A separate workflow sends the same verified Git commit to CNB. CNB builds andaudits the public Tencent TCR image inside Tencent Cloud after the formaldiff --git a/docs/release.zh-CN.md b/docs/release.zh-CN.mdindex 64c9421c..ca15239d 100644--- a/docs/release.zh-CN.md+++ b/docs/release.zh-CN.md@@ -37,29 +37,19 @@ bun run release -- \--ignore-commit "89abcde:仅增加测试覆盖"```-覆盖审计在修改本地或 GitHub 状态之前执行。映射记录在跟踪 Issue 中,不写入-公开 Release 说明。公开说明包含用户可感知的变化、影响、必要的迁移提醒,以及-可选的贡献者致谢。+覆盖审计在修改本地或 GitHub 状态之前执行,映射记录在跟踪 Issue 中。+使用 `--dry-run` 预览提交覆盖、原生端重建计划和 Release 说明。-如需感谢本次版本的贡献者,可在发布命令中按 GitHub 用户名逐个追加-`--contributor`:+### 外部贡献者署名-```bash---contributor alice --contributor "@bob"-```--发布前人工核对名单,可包括帮助本次版本的代码、翻译、文档贡献者或问题报告者;-排除机器人,默认不重复列出维护者。用户名可带开头的 `@`,忽略大小写去重,保留-首次填写的拼写和顺序。脚本在双语说明末尾追加-`贡献者 / Contributors:@alice @bob`;不传参数时说明保持原样。GitHub 根据这些-提及展示原生 Contributors 头像列表。脚本不会从提交推断名单,也不会向 GitHub-核验账号。使用 `--dry-run` 预览文本。续跑已有 Draft 时保留其原有说明;若需修正-致谢,请在发布前直接编辑该 Draft。+- 维护者本人完成的内容无需署名;外部贡献在对应条目末尾注明 `@username` 和 PR。+- 同一人贡献多项时可改为集中致谢。结尾名单仅列出未逐条致谢的人,名单为空则省略。+- GitHub 原生 Contributors 头像区由正文中的 `@username` 自动生成,逐条提及同样有效。-使用 `--dry-run` 查看提交覆盖、原生端重建计划和说明。发布完成后不会下载、-安装或启动 macOS 应用;已安装的 macOS、Windows 与 Linux 桌面端通过应用内自动-更新机制获取新版。Linux 预览版发布前必须通过真实 AppImage 跨版本更新验证。仅在-确实需要原有安装验收时显式传入 `--install-desktop`。+逐条署名写入 `--change-zh` / `--change-en`;集中名单使用可重复的+`--contributor alice`,脚本会在双语说明末尾追加+`贡献者 / Contributors:@alice`。该参数不自动推断贡献者。+续跑已有 Draft 时保留原说明,调整署名需直接编辑 Draft。## EdgeEver 特有规则@@ -75,7 +65,7 @@ bun run release -- \GitHub Tag,避免仅涉及 Web 或 API 的 Release 触发无效原生更新。- 脚本负责创建跟踪 Issue 和 Draft Release、验证或复用原生资产、准备并审计GHCR 多架构 Docker 镜像、正式发布、关闭 Issue,- 默认不安装桌面端应用;安装能力作为显式选项保留。+ 默认不安装桌面端应用;安装验收需显式传入 `--install-desktop`。输出 Actions 链接后,Demo 部署会独立继续执行。- 独立工作流会把同一个已验证 Git 提交发送到 CNB;正式 Release 发布后,CNB在腾讯云侧异步构建并审计 TCR 公共镜像。其耗时或失败不会阻塞 GitHub