Этот репозиторий используется в учебных целях в рамках курса «Инженерия Искусственного Интеллекта». Репозиторий может быть публичным, поэтому обращайтесь с данными и секретами максимально осторожно.
Ниже перечислены правила, которые необходимо соблюдать всем студентам.
-
Репозиторий не должен содержать:
- реальных персональных данных третьих лиц;
- секретов доступа (пароли, токены, приватные ключи и т.п.);
- конфиденциальной или служебной информации.
-
Всё, что вы выкладываете в репозиторий, рассматривается как информация, которую условно можно показать внешнему миру.
-
Если вам нужны реальные данные для проекта:
- используйте обезличивание/анонимизацию;
- по возможности заменяйте реальные данные синтетическими.
Строго запрещено коммитить:
-
Секреты и учетные данные:
- пароли, токены API, ключи доступа (включая токены Telegram, Discord, VK, GitHub, облаков и т.п.);
- приватные ключи (
id_rsa,.pem,.keyи др.); - файлы
.envс реальными значениями секретов; - куки, экспортированные сессии, дампы менеджеров паролей.
-
Персональные данные (ПДн) третьих лиц:
- реальные ФИО, телефоны, адреса, e-mail, логины;
- паспортные данные, номера полисов, СНИЛС и т.п.;
- любые таблицы/выгрузки с идентифицирующей информацией.
-
Конфиденциальную/служебную информацию:
- закрытые внутренние документы организаций;
- выгрузки из реальных внутренних систем без явного разрешения.
Если вы случайно закоммитили секрет или ПДн, необходимо:
- немедленно удалить файл из репозитория;
- при необходимости переписать историю (или сообщить преподавателю);
- скомпрометированные секреты нужно отозвать/заменить.
Что можно использовать в репозитории:
- общедоступные открытые датасеты (OpenML, Kaggle, UCI и т.п.), если это не нарушает их лицензию;
- синтетические данные, сгенерированные специально для проекта;
- обезличенные данные, из которых невозможно восстановить конкретное лицо;
- небольшие демонстрационные выборки, необходимые для запуска проекта, без ПДн и секретов.
Если есть сомнения, можно исходить из простого правила:
«Если я не уверен, можно ли это показать кому угодно – лучше не класть в репозиторий».
- Реальные секреты и пароли храните только локально, вне репозитория.
- Для конфигураций используйте:
- файлы в
project/configs/(например,config.yaml); - шаблоны окружения, например:
.env.exampleбез реальных значений.
- файлы в
Рекомендуемый подход:
- В репозитории:
project/configs/.env.example– список переменных окружения без значений.
- Локально (не в репозитории):
- файл
.envс реальными значениями (он игнорируется.gitignore).
- файл
В репозитории уже настроен файл .gitignore, который помогает:
- не добавлять в Git временные файлы, кеши и окружения;
- случайно не закоммитить
.envи некоторые другие служебные файлы.
Перед коммитом:
- Просматривайте список изменённых файлов (
git status,git diff). - Убедитесь, что среди них нет:
- неожиданных файлов данных,
- секретов,
- временных артефактов.
Соблюдение этих правил:
- снижает риски утечек данных и компрометации аккаунтов;
- помогает придерживаться требований законодательства о персональных данных и внутренних политик организации;
- формирует у вас корректные практики разработки ИИ-систем.
Если вы не уверены, можно ли добавлять конкретный файл в репозиторий, лучше:
- не коммитить его;
- уточнить у преподавателя.