5
0
mirror of https://github.com/cwinfo/matterbridge.git synced 2024-11-10 08:40:29 +00:00
matterbridge/vendor/github.com/SevereCloud/vksdk/v2/CONTRIBUTING.md
Wim 08779c2909
Update dependencies (#2007)
* Update dependencies
2023-03-09 22:48:00 +01:00

2.2 KiB
Raw Blame History

Contributing

Настройки

vksdk написан на Go.

Требования:

Сделайте fork и клонируйте vksdk куда угодно:

git clone git@github.com:<your name>/vksdk.git

Создайте новую ветку

git checkout -b <name_of_your_new_branch>

Тестирование изменений

Для начала проверьте ваш код с помощью golangci-lint

golangci-lint run

Затем можно запускать тесты

# SERVICE_TOKEN=""
# GROUP_TOKEN=""
# CLIENT_SECRET=""
# USER_TOKEN=""
# WIDGET_TOKEN=""
# MARUSIA_TOKEN=""
# CLIENT_ID="123456"
# GROUP_ID="123456"
# ACCOUNT_ID="123456"
go test ./...

Задавать токены не обязательно - тесты с их использованием будут пропущены. Не рекомендуется задавать свой USER_TOKEN, так как тесты делают много страшных вещей.

Настройки для VSCode .vscode/setting.json

{
  "go.testEnvVars": {
    "SERVICE_TOKEN": "",
    "WIDGET_TOKEN": "",
    "MARUSIA_TOKEN": "",
    "GROUP_TOKEN": "",
    "CLIENT_SECRET": "",
    "USER_TOKEN": "",
    "CLIENT_ID": "123456",
    "GROUP_ID": "123456",
    "ACCOUNT_ID": "123456"
  }
}

Создание коммита

Сообщения коммитов должны быть хорошо отформатированы, и чтобы сделать их «стандартизированным», мы используем Conventional Commits.

git add .
git commit

Отправьте pull request

Отправьте изменения в ваш репозиторий

git push origin <name_of_your_new_branch>

Затем откройте pull request с веткой master