Skip to content

contributing.md

Latest commit

 

History

History
240 lines (192 loc) · 8.52 KB

contributing.md

File metadata and controls

240 lines (192 loc) · 8.52 KB

Как внести вклад в проект

Спасибо, что хотите внести вклад в развитие формата База данных дела! Это открытый проект, и мы приветствуем участие сообщества.

📋 Типы вклада

Для всех

  • ⭐ Поставьте звезду проекту на GitHub
  • 📢 Расскажите друзьям о проекте
  • 📝 Сообщите об ошибках через Issues
  • 💡 Предложите идеи для улучшения

Для разработчиков

  • 🛠️ Создайте реализацию на новом языке
  • 🧪 Напишите тесты для валидации формата
  • 📚 Улучшите документацию
  • 🐛 Исправьте ошибки в коде

Для юристов и экспертов

  • ⚖️ Протестируйте формат в реальных делах
  • 📋 Предложите новые поля для моделей данных
  • 📊 Поделитесь кейсами использования
  • 🎯 Оцените usability для юридической практики

🚀 Быстрый старт для контрибьюторов

1. Форкните репозиторий

# На GitHub нажмите "Fork" для этого репозитория
# Или через командную строку:
git clone https://github.com/YOUR_USERNAME/case-database-format.git
cd case-database-format
git remote add upstream https://github.com/KAPLAW-RU/case-database-format.git

2. Создайте ветку для вашей работы

git checkout -b feature/your-feature-name
# или
git checkout -b fix/issue-number

3. Внесите изменения

# Редактируйте файлы
# Добавьте тесты если нужно
# Обновите документацию

4. Создайте Pull Request

git add .
git commit -m "Описание изменений"
git push origin feature/your-feature-name
# Создайте PR на GitHub

🎯 Что можно улучшить

Спецификация формата

  • Добавить новые типы дел (арбитражные, уголовные, административные)
  • Расширить модель участников дела
  • Добавить поддержку мультиязычности
  • Создать подспецификации для разных типов дел

Реализации

  • JavaScript/TypeScript библиотека
  • Python библиотека
  • Java библиотека
  • C#/.NET библиотека
  • Go библиотека
  • Rust библиотека

Инструменты

  • CLI для работы с базами данных
  • Веб-интерфейс для просмотра баз
  • Валидатор JSON Schema
  • Конвертеры из других форматов (CSV, XML, etc.)
  • Генератор отчетов

Документация

  • Туториалы по созданию реализаций
  • Примеры использования в разных доменах
  • API Reference для каждой реализации
  • Кейсы использования из практики

📝 Правила оформления кода

Общие правила

  • Используйте понятные имена переменных и функций
  • Добавляйте комментарии к сложной логике
  • Следуйте принципам SOLID и DRY
  • Пишите тесты для нового кода

JavaScript/TypeScript

// Хороший стиль
class CaseDatabaseManager {
    /**
     * Создает новую базу данных дела
     * @param {string} folderPath - Путь к папке дела
     * @returns {Promise<CaseDatabase>} Созданная база данных
     */
    async createDatabase(folderPath) {
        // Валидация входных данных
        if (!folderPath) {
            throw new Error('Путь к папке обязателен');
        }

        // Логика создания
        const database = new CaseDatabase();
        // ...
    }
}

Python

class CaseDatabaseManager:
    """
    Менеджер для работы с базами данных дел
    """

    def create_database(self, folder_path: str) -> CaseDatabase:
        """
        Создает новую базу данных дела

        Args:
            folder_path: Путь к папке дела

        Returns:
            Созданная база данных

        Raises:
            ValueError: Если путь не указан
        """
        if not folder_path:
            raise ValueError("Путь к папке обязателен")

        database = CaseDatabase()
        # Логика создания...
        return database

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

Запуск тестов

# Для JavaScript
npm test

# Для Python
pytest

# Для других языков - смотрите в соответствующей папке

Написание тестов

  • Тестируйте основные функции
  • Проверяйте граничные случаи
  • Тестируйте валидацию данных
  • Добавляйте интеграционные тесты

📚 Документация

Обновление спецификации

Если вы предлагаете изменения в спецификацию:

  1. Обновите SPECIFICATION.md
  2. Обновите JSON Schema в schemas/
  3. Обновите примеры в examples/
  4. Проверьте совместимость с существующими реализациями

Добавление примеров

// Пример нового типа дела в examples/
{
  "version": "1.1",
  "metadata": {
    "caseName": "Уголовное дело № 123456",
    "category": "Уголовное дело",
    // ...
  },
  // ...
}

🔄 Процесс Code Review

  1. Автоматическая проверка

    • Проверка стиля кода (ESLint, Prettier, Black)
    • Запуск тестов
    • Валидация JSON Schema

  2. Ручная проверка

    • Проверка логики изменений
    • Совместимость с существующими реализациями
    • Документация изменений

  3. Слияние

    • После одобрения maintainer'ов
    • Обновление версий при необходимости

🎉 Награды за вклад

Badges для профиля

  • 💻 Developer - первая реализация на новом языке
  • 🧪 Tester - написание комплексных тестов
  • 📚 Writer - улучшение документации
  • 🐛 Debugger - исправление критических багов
  • 💡 Innovator - предложение прорывных идей

Признание

  • Упоминание в Release Notes
  • Добавление в список контрибьюторов
  • Возможность стать maintainer'ом

📞 Получить помощь

Где спросить

  • 💬 GitHub Discussions - общие вопросы
  • 🐛 GitHub Issues - баги и фичи
  • 💬 Discord/Telegram - оперативная помощь

Контакты maintainer'ов

📋 Checklist для Pull Request

  • Код соответствует стилю проекта
  • Добавлены/обновлены тесты
  • Обновлена документация
  • Проведено тестирование на совместимость
  • Описаны breaking changes (если есть)

🙏 Благодарность

Спасибо всем, кто участвует в развитии проекта! Вместе мы создаем стандарт для LegalTech индустрии.

"Маленькие шаги приводят к большим изменениям" 🚀