Перейти к основному содержимому

Внести вклад за 10 минут

Начальный

AILmanac остаётся "полным и всегда свежим" только потому, что такие люди, как вы, дополняют его. Вам не нужно быть разработчиком — исправление опечатки, добавление термина в глоссарий или публикация шаблона — всё это настоящий вклад.

Быстрый путь​

  1. Найдите страницу на сайте и нажмите "Edit this page" внизу (она откроет файл на GitHub).
  2. Нажмите карандаш ✏️, чтобы редактировать в браузере. GitHub автоматически создаст для вас форк репозитория.
  3. Внесите своё изменение в Markdown.
  4. Внизу напишите краткое описание и предложите изменения → откройте pull request.
  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. Простой язык, примеры важнее теории. Короткие предложения. Показывайте, а не просто рассказывайте.

Шаблон front-matter страницы​

---
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.