- Updated all CI/CD workflow files (.github/workflows/) to use tools/scripts/ paths - Updated CONTRIBUTING.md and all documentation in docs/ directory - Updated data/inbox/inbox/ documentation files - Updated tools/scripts/generate_sources_table.py self-references - Fixed pr-checks.yml linting paths (black, ruff, mypy, coverage) - All validations passing with new paths Co-authored-by: ArtemFilin1990 <221041513+ArtemFilin1990@users.noreply.github.com>
2.5 KiB
2.5 KiB
Contributing to BearingsInfo
Спасибо за интерес к проекту BearingsInfo! Мы приветствуем вклад в развитие базы данных подшипников.
Как внести вклад
Добавление информации о подшипниках
- Форкните репозиторий
- Создайте новую ветку (
git checkout -b feature/bearing-data) - Добавьте данные в соответствующие файлы в
data/или документацию вdocs/bearings/ - Убедитесь, что данные содержат ссылки на источники (ГОСТ, ISO, DIN, каталоги производителей)
- Запустите валидацию:
python tools/scripts/validate/run_validations.py - Закоммитьте изменения (
git commit -m 'Add: данные по подшипнику XXX') - Запушьте ветку (
git push origin feature/bearing-data) - Откройте Pull Request
Требования к данным
- Все технические данные должны содержать ссылки на официальные источники
- CSV файлы должны быть в UTF-8 кодировке
- Названия и обозначения должны соответствовать стандартам (ГОСТ, ISO, DIN)
- Избегайте дублирования записей
Структура репозитория
data/— CSV файлы с данными подшипниковdocs/bearings/— документация по классификации, стандартам, аналогамsources/— скрипты для парсинга источников данныхtools/scripts/— утилиты для валидации и обработки данных
Запуск тестов
python -m pip install -r requirements.txt
python tools/scripts/deduplicate_nomenclature.py
python tools/scripts/update_repo.py --no-report
python tools/scripts/validate/run_validations.py
pytest -v
Стиль кода
- Python: PEP 8
- Markdown: используйте заголовки, списки, таблицы для структурирования
- CSV: разделитель — запятая, кодировка UTF-8
Вопросы
Если у вас есть вопросы, создайте Issue в репозитории.