5
0
mirror of https://github.com/cwinfo/matterbridge.git synced 2024-09-20 14:52:30 +00:00
matterbridge/vendor/github.com/SevereCloud/vksdk/v2/CONTRIBUTING.md
dependabot[bot] 5a1fd7dadd
Bump github.com/SevereCloud/vksdk/v2 from 2.11.0 to 2.13.0 (#1698)
Bumps [github.com/SevereCloud/vksdk/v2](https://github.com/SevereCloud/vksdk) from 2.11.0 to 2.13.0.
- [Release notes](https://github.com/SevereCloud/vksdk/releases)
- [Commits](https://github.com/SevereCloud/vksdk/compare/v2.11.0...v2.13.0)

---
updated-dependencies:
- dependency-name: github.com/SevereCloud/vksdk/v2
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-01-28 23:48:40 +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=""
# 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 если это багфикс
  • dev-v1.2.3 если это новая фича