Skip to content

Commit

Permalink
add CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
king-tri-ton committed Sep 3, 2024
1 parent 2627f12 commit 0312dc3
Showing 1 changed file with 75 additions and 0 deletions.
75 changes: 75 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Вклад в MiniBin

Спасибо, что решили внести вклад в MiniBin! Для упрощения процесса внесения изменений, пожалуйста, следуйте этим рекомендациям.

## Начало работы

1. **Форкните Репозиторий**:
- Нажмите кнопку "Fork" в правом верхнем углу страницы репозитория на GitHub.

2. **Клонируйте Ваш Форк**:
```bash
git clone https://github.com/king-tri-ton/minibin.git
cd ВАШ_ФОРК
```

3. **Настройте Upstream Remote**:
- Добавьте оригинальный репозиторий как upstream remote:
```bash
git remote add upstream https://github.com/king-tri-ton/{repo}.git
```

4. **Установите Зависимости**:
- Убедитесь, что у вас установлен Python и PyQt6. Установите PyQt6 с помощью pip:
```bash
pip install PyQt6
```

## Внесение Изменений

1. **Создайте Новую Ветку**:
```bash
git checkout -b feature/ваша-функция
```

2. **Внесите Изменения**:
- Модифицируйте код по необходимости. Убедитесь, что ваш код соответствует стандартам проекта.

3. **Протестируйте Изменения**:
- Запустите приложение и убедитесь, что ваши изменения работают как ожидается.

4. **Закоммитьте Изменения**:
```bash
git add *
git commit -m "Добавьте описательное сообщение о ваших изменениях"
```

5. **Отправьте Изменения**:
```bash
git push origin feature/ваша-функция
```

6. **Создайте Pull Request**:
- Перейдите в репозиторий на GitHub и нажмите кнопку "Compare & pull request". Опишите свои изменения и отправьте pull request.

## Стандарты Кодирования

- Следуйте PEP 8 для стиля кода на Python.
- Используйте описательные сообщения для коммитов.
- Обеспечьте правильную обработку ошибок и комментарии в коде.

## Тестирование

- Убедитесь, что ваши изменения не ломают существующий функционал.
- Проверьте, что все новые функции работают как ожидается.

## Сообщение Об Ошибках

- Чтобы сообщить об ошибках или предложить новые функции, используйте вкладку "Issues" в репозитории на GitHub.
- Укажите подробное описание и шаги для воспроизведения проблемы.

## Контакт

- Для вопросов или дополнительной помощи свяжитесь с поддержкой проекта через GitHub.

Спасибо за вклад в MiniBin!

0 comments on commit 0312dc3

Please sign in to comment.