Как внести вклад
Определите область для вклада
Есть несколько способов определить область, в которой Вы можете внести свой вклад в TON Docs:
- Присоединяйтесь к чату TON Docs Club в Telegram и получайте информацию о последних задачах от сопровождающих.
- Если у Вас на примете есть конкретный вклад, но Вы не уверены в нём, уточните, подходит ли этот вклад, обратившись напрямую к одному из сопровождающих Docs.
- Ознакомьтесь с наиболее часто задаваемыми вопросами в чатах TON Developers.
- Пожалуйста, ознакомьтесь с issues в репозитории GitHub.
- Изучите доступные footsteps для документации.
TL;DR
- Если Вам нужно добавить или изменить что-то в TON Docs, создайте запрос тяги
к ветке
main. - Команда разработчиков документации рассмотрит запрос на привлечение или свяжется с Вами при необходимости.
- Репозиторий: https://github.com/ton-community/ton-docs
Разработка
Онлайновая установка взносов в один клик
Вы можете использовать Gitpod (бесплатную, онлайновую, похожую на VS code IDE) для внесения вклада. Он запустит рабочую область одним щелчком мыши и автоматически:
Кодовые конвенции
- Самое важное: оглянитесь вокруг. Соответствуйте общему стилю проекта. Это включает форматирование, именование файлов, именование объектов в коде, именование вещей в документации и так далее.
- Для документации: При редактировании документации не заворачивайте строки на 80 символов; вместо этого настройте свой редактор на мягкое заворачивание.
Не беспокойтесь слишком сильно о стилях в целом; сопровождающие помогут Вам исправить их, когда будут просматривать Ваш код.
Pull Requests
Итак, Вы решили внести свой код обратно в upstream, открыв запрос на исправление. Вы приложили много усилий, и мы ценим это. Мы сделаем все возможное, чтобы сотрудничать с Вами и добиться рассмотрения запроса.
При подаче запроса на исправление, пожалуйста, убедитесь в следующем:
- Сохраняйте свой запрос на исправление небольшим. Маленькие запросы (~300 строк различий) легче просматривать и больше шансов, что они будут объединены. Убедитесь, что запрос на исправление делает только одну вещь, в противном случае, пожалуйста, разделите его.
- Используйте описательные заголовки. Рекомендуется придерживаться стиля сообщений фиксации.
- Тестируйте свои изменения. Опишите план тестирования в описании Вашего запроса на выгрузку.
Все запросы на исправление должны быть открыты в ветке main.
Что происходит дальше?
Команда TON Docs будет следить за запросами на доработку. Пожалуйста, помогите нам, следуя приведенным выше рекомендациям, чтобы запросы на доработку были согласованными.