75 lines
2.8 KiB
Markdown
75 lines
2.8 KiB
Markdown
# Руководство для контрибьюторов
|
||
|
||
## Лицензирование
|
||
|
||
При внесении изменений в проект DLE (Digital Legal Entity) вы соглашаетесь с тем, что ваш код будет распространяться под **Proprietary Software License**.
|
||
|
||
## Авторские права
|
||
|
||
Все контрибьюторы должны:
|
||
- Указывать свое имя в коммитах
|
||
- Соглашаться с передачей прав на код автору проекта
|
||
- Не нарушать авторские права третьих лиц
|
||
|
||
## Процесс внесения изменений
|
||
|
||
### 1. Подготовка
|
||
- Создайте fork репозитория
|
||
- Клонируйте ваш fork локально
|
||
- Создайте feature branch для ваших изменений
|
||
|
||
### 2. Разработка
|
||
- Следуйте стандартам кодирования проекта
|
||
- Добавляйте комментарии к коду на русском языке
|
||
- Тестируйте ваши изменения
|
||
|
||
### 3. Коммиты
|
||
- Используйте понятные сообщения коммитов
|
||
- Указывайте свое имя в коммитах
|
||
- Разбивайте большие изменения на логические части
|
||
|
||
### 4. Pull Request
|
||
- Создайте Pull Request с описанием изменений
|
||
- Укажите, какие проблемы решает ваш код
|
||
- Дождитесь review от автора проекта
|
||
|
||
## Стандарты кода
|
||
|
||
### Именование
|
||
- Файлы и папки: kebab-case
|
||
- Переменные и функции: camelCase
|
||
- Константы: UPPER_SNAKE_CASE
|
||
- Классы: PascalCase
|
||
|
||
### Комментарии
|
||
```javascript
|
||
/**
|
||
* @copyright 2024-2025 Тарабанов Александр Викторович
|
||
* @license Proprietary
|
||
* @author [Ваше имя] <ваш-email@example.com>
|
||
*/
|
||
```
|
||
|
||
### Git сообщения
|
||
```
|
||
feat: добавить новую функцию авторизации
|
||
fix: исправить ошибку в валидации данных
|
||
docs: обновить документацию API
|
||
style: форматирование кода
|
||
refactor: рефакторинг модуля пользователей
|
||
test: добавить тесты для нового функционала
|
||
```
|
||
|
||
## Контакты
|
||
|
||
### По вопросам участия в проекте:
|
||
- **Email:** info@hb3-accelerator.com
|
||
- **GitHub Issues:** [Создать issue](https://github.com/DAO-HB3-Accelerator/DLE/issues)
|
||
|
||
### Автор проекта:
|
||
**Тарабанов Александр Викторович**
|
||
Email: info@hb3-accelerator.com
|
||
|
||
---
|
||
|
||
**Спасибо за ваш вклад в развитие проекта DLE!** |