Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 3.45 KB

File metadata and controls

63 lines (42 loc) · 3.45 KB

Требование к процессу

Общее описание

Когда беремся за задачу, реализации некого функционала создав ветку и разобравшись с самой задачей, пишем код исключительно ТОТ, который покрывает фукнционал задачи. Не более, если нужно что-то реализовать, что выходит за рамки задачи, создается для этого другая ветка и применяется сначала она.

Так же имеются дополнительный ряд критериев, чего нужно и ненужно применять в работе.

Пароли и секретные данные

Никакие ключи, доступы до других API сервисов и прочие значения не коммитим! Для них создается файлик .env куда в формате ключ-значение записываются нужные ключи.

API_SECRET_KEY=
FCM_ACCESS_TOKEN=
SECRET_KEY=
DATABASE_PASSWORD=
...

Для локальной среды меняются под себя значения в файле .env, и применяются одной коммандой при запуске проекта.

$ source .env

Так же, можно в настройках PyCharm указать, чтобы этот файл сразу подключался при старте проекта.

Продакшен и тест стенды используют эти переменные, прописанные в GitLab Variables. Этоже необходимо описывать в комментарии при MR, что добавленна переменная, и значения для нее к тестовому и продакшен стенду.

Презентационные функции

Если вы реализовали новую страничку, которую "сверстали". Нет необходимости создавать View функцию, которая отобразит и покажет Вашу страничку. Задача должна быть выполнена полностью, значит страничка должна "подключаться" к какой-то рабочей функции и отображаться.

Зависимости

Если вы используете новую библиотеку в проекте по каким-то причинам, незабудьте указать ее в файле заивисимостей.

  • requirements.txt
  • package.json
  • Dockerfile
  • прочее

Чтобы при разворачивании проекта на стенде не выявлялось такого, что проект требует библиотеку, которая не установлена.

gitignore

Стараемся соблюдать и дополнять файл .gitignore чтобы "лишних" файлов не было в репозитории, таких как:

  • дампы к базе данных
  • временно залитые медиа файлы
  • ни к чему не относящиеся SQL файлы
  • large-files, если в них совсем нет нужды
  • файлы создаваемые IDE
  • файлы кеша и тесов