5
0
mirror of https://github.com/cwinfo/matterbridge.git synced 2024-09-20 19:32:31 +00:00
matterbridge/vendor/github.com/SevereCloud/vksdk/v2/CONTRIBUTING.md
Ivanik 8764be7461
Add vk bridge (#1372)
* Add vk bridge

* Vk bridge attachments

* Vk bridge forwarded messages

* Vk bridge sample config and code cleanup

* Vk bridge add vendor

* Vk bridge message edit

* Vk bridge: fix fetching names of other bots

* Vk bridge: code cleanup

* Vk bridge: fix shadows declaration

* Vk bridge: remove UseFileURL
2021-01-29 00:25:14 +01:00

2.3 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=""
# CLIENT_ID="123456"
# GROUP_ID="123456"
# ACCOUNT_ID="123456"
go test ./...

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

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

{
    "go.testEnvVars": {
        "SERVICE_TOKEN": "",
        "WIDGET_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 если это багфикс
  • dev-v1.2.3 если это новая фича