update readme

README.md

@@ -1,6 +1,15 @@
 # common
 
+# Репозиторий для хранения общих ресурсов сервиса (squiz), входит в использование core,answerer,store,worker
 
+## Правила использования
+#### 1.Написание запросов к базе данных - в файле `dal/db_query/queries.sql`, файл используется для генерации обработки запросов с помощью sqlc, для этого используется `sqlc.yaml` для указания текущих схем базы данных, это сейчас миграции расположены в `dal/schema`, для того чтобы сгенерировать запрос нужно стянуть пакет sqlc с офф сайта, написать запрос (задать ему имя, и тип возвращаемых значений), прописать команду `sqlc generate`, после этого файлы сгенерируются
+#### 2.Также в репозитории указаны методы которые используются в контроллерах которые испольюзуют этот репозиторий, находятся в папке `repository`, инициализируется все вместе для каждого из репо `dal/dal.go`
+#### 3.Хранятся такие основные фичи как структуры `model` и промежуточное ПО `middleware`, которые используются во всем проекте `squiz`
+## Пуш/go get
+#### 1.После изменения `чего то` стоит свичнуться на новую ветку и запушить изменения в нее, это рекомендовано для версионирования того что изменяется в основном проекте, так как обновление может происходить не во всем репо, то изменения могут быть применены к одну и тд из репо, что упрощает просмотр багов и их устранение посредством просмотра рабочей ветки проекта в репозитории `common`
+#### 2.Стягивание репозитория `common` в нужный проект происходит по средством `go get penahub.gitlab.yandexcloud.net/backend/quiz/common.git@NAMEBRANCH`, после этого рекомендуется прописать `go mod tidy` для обновления зависимостей `go.mod` и поднять локально окружение дабы протестировать работоспособность с измененным `common`
+#### 3.Предложение: При каждом изменении в рабочих ветках и стягивании `common` в проект писать в файл `version` название ветки `common` которая заменили предыдущую для более понятного отслеживания на данном этапе разарботки
 
 ## Getting started