mirror of
https://github.com/hackdiaz-dev/free-turn-proxy.git
synced 2026-10-12 09:41:53 +02:00
samosvalishe
34 lines
2.5 KiB
Markdown
34 lines
2.5 KiB
Markdown
# Руководство для контрибьюторов (Contributing Guidelines)
|
|
|
|
Спасибо за ваш интерес к проекту Free Turn Proxy! Мы рады любой помощи: от исправления опечаток и багов до добавления новых функций.
|
|
|
|
## Как начать
|
|
|
|
1. Сделайте форк репозитория.
|
|
2. Создайте новую ветку для вашей фичи или исправления бага (`git checkout -b feature/your-feature-name` или `git checkout -b fix/your-bug-fix`).
|
|
3. Внесите изменения в код.
|
|
4. Убедитесь, что ваш код соответствует стандартам проекта. Запустите линтер и тесты:
|
|
```bash
|
|
task lint
|
|
task test
|
|
```
|
|
5. Закоммитьте изменения с понятным описанием (`git commit -m 'feat: add some feature'`). Рекомендуем использовать [Conventional Commits](https://www.conventionalcommits.org/).
|
|
6. Отправьте ветку в свой форк (`git push origin feature/your-feature-name`).
|
|
7. Откройте Pull Request (PR) в оригинальный репозиторий.
|
|
|
|
## Стандарты кода
|
|
|
|
- Мы используем стандартное форматирование Go. Вы можете отформатировать код с помощью `task format`.
|
|
- Старайтесь писать понятные комментарии к сложному коду.
|
|
- Если вы добавляете новую функциональность, пожалуйста, добавьте соответствующие тесты.
|
|
|
|
## Сообщения о багах и предложения
|
|
|
|
Если вы нашли баг или у вас есть идея по улучшению, пожалуйста, создайте Issue, используя предоставленный шаблон. Постарайтесь описать проблему максимально подробно, чтобы нам было проще её воспроизвести и исправить.
|
|
|
|
## Нужна помощь?
|
|
|
|
Если у вас есть вопросы по проекту или вы не знаете, с чего начать, не стесняйтесь открывать Issue с вопросом. Мы с радостью вам поможем!
|
|
|
|
Спасибо за ваш вклад в развитие Free Turn Proxy!
|