跳到主要内容

十分钟参与贡献

入门

AILmanac 之所以能“内容完整且始终新鲜”,正是因为有像你这样的人在不断为它添砖加瓦。你需要是开发者——修正一个错别字、添加一个术语,或分享一个模板,都是实实在在的贡献。

快速路径

  1. 在站点上找到那个页面,点击底部的**“编辑此页”**(它会在 GitHub 上打开该文件)。
  2. 点击 ✏️ 铅笔图标在浏览器中编辑。GitHub 会自动为你 fork 仓库。
  3. 用 Markdown 完成你的改动。
  4. 在底部写一句简短的说明,然后提议改动发起拉取请求
  5. 由维护者审阅。就这样。🎉

更喜欢在本地操作?克隆仓库,然后:

npm install
npm run start # live preview at http://localhost:3000
npm run build # must pass: it fails on broken links

每个页面都遵循的 4 条规则

遵守这些规则能让审阅更快,并让质量保持高水准:

  1. 标注级别。 在正文开头加上 <LevelBadge level="beginner" />(或 intermediate / advanced / all)。
  2. 为易变事实链接来源。 任何关于模型名称、价格、限制或会变化的功能的内容,都必须引用官方页面——并使用 <VerifyNote lastVerified="YYYY-MM-DD" source="..." />。切勿硬编码模型相关事实;改为链接到模型表
  3. 先给观点,然后保持诚实。 先给出推荐做法;再说明替代方案。不要复述官方文档——链接到它即可。
  4. 平实的语言,例子胜过理论。 句子要短。展示,而不只是讲述。

页面前置元数据模板

---
sidebar_position: 2
title: Your Page Title
description: One sentence shown in search and previews.
keywords: [relevant, search, terms]
---

<LevelBadge level="beginner" />

Your first paragraph...

什么样的首次贡献最出色

  • 添加一个缺失的术语条目。
  • 添加一个你已经在用的模板或提示词。
  • 修正某个新发布而导致页面现在写错的内容(并更新它的 lastVerified 日期)。
  • 翻译一个页面——参见翻译手册

许可与签署

通过贡献,你即同意你的文字以 CC BY 4.0 共享、代码以 MIT 共享,并在你的提交中加上 Signed-off-by 行(DCO)(git commit -s)。详见治理页面

请保持友善——我们遵循 Contributor Covenant 行为准则