Skip to content

TechCon-ML-Team/.github

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub-поверхности организации TechCon ML Team

Что это за репозиторий

Этот meta-репозиторий хранит общие GitHub-поверхности организации:

  • публичную профильную страницу организации;
  • шаблоны задач и pull request;
  • правила участия и code owners;
  • общие служебные материалы по репозиторному контуру.

Это не продуктовый репозиторий. Его задача — держать GitHub-контур организации понятным, согласованным и пригодным для сопровождения.

Что здесь считается основными поверхностями

Публичная поверхность

  • profile/README.md

Именно этот файл формирует публичную страницу организации на GitHub.

Внутренняя поверхность

  • README.md
  • dev/status.md
  • связанные governance-артефакты в techcon_hub

Эти файлы нужны для внутреннего сопровождения GitHub-контура: роли репозиториев, правила доступа, качество локализации, организация onboarding и change-review.

Как теперь поддерживать страницу организации

Когда править публичную страницу

Правка нужна, если изменилось хотя бы одно из следующего:

  • основные направления экосистемы;
  • демонстрационные поверхности;
  • позиционирование команды;
  • базовый стек и инженерный контур;
  • правила того, как внешнему читателю понимать организацию.

Когда править внутреннюю поверхность

Правка нужна, если изменилось:

  • распределение ролей между репозиториями;
  • правила доступа;
  • политика локализации и качества документации;
  • порядок сопровождения GitHub-организации.

Рабочий порядок

  1. Сначала свериться с актуальным состоянием в dev/status.md и с hub-планами.
  2. Затем проверить действующие стандарты локализации и документации.
  3. После этого вносить точечные изменения в:
    • profile/README.md — для публичной страницы;
    • README.md и связанные governance-артефакты — для внутренней страницы.
  4. Если меняются description, pinned repositories или права доступа в самой организации, это нужно делать осознанно и отдельно от обычной правки текста.

Обязательные стандарты

При правках этой поверхности действуют:

  • русскоязычная локализация описательного текста;
  • единый стиль внутрирепозиторной документации;
  • запрет на выдуманные инфраструктурные или продуктовые обещания.

Смысл простой:

  • публичная страница должна быть полезной внешнему читателю;
  • внутренняя — полезной сопровождающему;
  • обе должны быть написаны ясным русским инженерным языком.

Что нельзя делать вслепую

  • нельзя придумывать новые product claims без подтверждённой правды в репозиториях;
  • нельзя объявлять внешние демонстрационные поверхности стабильными, если они живут как подвижный showcase-контур;
  • нельзя смешивать изменение презентации организации с изменением прав доступа;
  • нельзя считать автоматически сгенерированный текст финальной истиной без ручной проверки.

Текущий фокус

Сейчас для GitHub-контура организации важны:

  • качественная русскоязычная публичная страница;
  • понятная внутренняя страница сопровождения;
  • отдельный контроль над governance-поверхностями: доступы, онбординг, реестр API-ключей, группировка репозиториев.

About

Org-wide community health files

Resources

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors