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

Как внести свой вклад

warning

Эта страница переведена сообществом на русский язык, но нуждается в улучшениях. Если вы хотите принять участие в переводе свяжитесь с @alexgton.

к сведению

Узнайте, как отправить контент в документацию TON здесь.

Правила внесения вклада​

Политика ведения документации​

Документация TON полностью открыта. Энтузиасты сообщества и ранние участники TON сыграли ключевую роль в создании этой открытой документации TON, превратив свои заметки в подробные страницы.

Первоначально она была написана [участниками] TON (/v3/contribute/maintainers/) и поддерживается [TON Studio] (https://tonstudio.io/). Мы стремимся рассказать пользователям о TON с помощью понятного контента с возможностью простого поиска, который понравится техническим экспертам и обычным читателям.

Как внести свой вклад​

к сведению

Эта документация написана на английском языке. Пожалуйста, обратитесь к программе локализации для других языков.

  1. Клонируйте текущую версию из репозитория GitHub ton-docs.
  2. Определите область для внесения вклада в соответствии с руководством по стилю и откройте связанную задачу.
  3. Ознакомьтесь со Стандартизацией контента и Типографикой.
  4. Откройте запрос на извлечение ветки main с четким описанием и краткими обновлениями в соответствии с шаблоном.

Шаблон запроса на объединение в пул​


## Description

Please provide a brief description of the changes introduced in this pull request. Include any relevant issue numbers or links.

## Checklist

- [ ] I have created an issue.
- [ ] I am working on content that aligns with the [Style guide](https://docs.ton.org/v3/contribute/style-guide/).
- [ ] I have reviewed and formatted the content according to [Content standardization](https://docs.ton.org/v3/contribute/content-standardization/).
- [ ] I have reviewed and formatted the text in the article according to [Typography](https://docs.ton.org/v3/contribute/typography/).

  1. Перед отправкой запроса на включение внесенных изменений выполните и проверьте каждый этап в контрольном списке описания.
к сведению

Чтобы избежать чрезмерной доработки, прочтите рекомендации по внесению вклада в Руководстве по стилю, Стандартизации контента и Типографики перед внесением вклада. Не беспокойтесь о незначительных проблемах; сопровождающие помогут вам исправить их в процессе проверки.

Разработка​

  • Изучите процесс разработки документации на основе документа ton-docs/README.md.

Лучшая практика для запросов на извлечение​

  1. Сделайте ваш pull request небольшим. Меньшие pull requests (~300 строк различий) легче проходят проверку и вероятнее всего будут приняты. Убедитесь, что pull request выполняет только одно действие, в противном случае разделите его.
  2. Используйте описательные заголовки. Рекомендуется придерживаться стиля сообщений фиксации.
  3. Протестируйте свои изменения. Запустите сборку локально и убедитесь, что у вас нет сбоев.
  4. Используйте мягкий перенос: не переносите строки по 80 символов; настройте редактор на мягкий перенос.

Общайтесь с другими разработчиками​

См. также​