Contributing / Вклад в проект

EN: We welcome your contributions to PopFrame! Please check the existing issues for bugs or enhancements to work on. If you have an idea for an extension, file a new issue so we can discuss it. Familiarize yourself with the project layout before making major contributions.

RU: Мы приветствуем ваш вклад в PopFrame! Ознакомьтесь с существующими задачами (issues) для поиска багов или улучшений. Если у вас есть идея для расширения, создайте новую задачу для обсуждения. Перед крупными изменениями ознакомьтесь со структурой проекта.

How to contribute / Как внести вклад

EN: To start developing PopFrame: 1. Clone the repository:

::
$ git clone https://github.com/Mvin8/PopFrame

(Optional) Create a virtual environment:

$ make venv
$ source .venv/bin/activate

Install the library in editable mode with development dependencies:
```
$ make install-dev
```
Install pre-commit hooks:
```
$ pre-commit install
```

Create a new branch:

$ git checkout -b develop <new_branch_name>

Make changes, update tests and documentation, and run:
```
$ make test
```
Commit and push your changes, then open a Pull Request.

RU: Для начала разработки PopFrame: 1. Клонируйте репозиторий:

::
$ git clone https://github.com/Mvin8/PopFrame

(Опционально) создайте виртуальное окружение:
```
$ make venv
$ source .venv/bin/activate
```
Установите библиотеку в editable-режиме с dev-зависимостями:
```
$ make install-dev
```
Установите pre-commit хуки:
```
$ pre-commit install
```

Создайте новую ветку:

$ git checkout -b develop <new_branch_name>

Вносите изменения, обновляйте тесты и документацию, запускайте:
```
$ make test
```
Зафиксируйте и отправьте изменения, откройте Pull Request.

Before submitting your pull request / Перед отправкой pull request

EN: - Update the documentation and README if your changes affect them. - Update or add tests for your code. - Make sure your code is properly commented and documented. - If you add dependencies, ensure they are easy to install via pip and support Python 3.

RU: - Обновите документацию и README, если ваши изменения их затрагивают. - Добавьте или обновите тесты для вашего кода. - Убедитесь, что код снабжён комментариями и docstring. - Новые зависимости должны легко устанавливаться через pip и поддерживать Python 3.

Contribute to the documentation / Вклад в документацию

EN: All documentation is created with Sphinx autodoc. Use .. automodule:: <module_name> for module documentation. Add new files to the toctree in api/index.rst.

RU: Вся документация создаётся с помощью Sphinx autodoc. Для описания модулей используйте .. automodule:: <module_name>. Новые файлы добавляйте в toctree в api/index.rst.

After submitting your pull request / После отправки pull request

EN: - Automated tests and code quality checks will run. - Address any errors if checks fail.

RU: - Будут запущены автоматические тесты и проверки качества кода. - Исправьте ошибки, если проверки не пройдены.

Acknowledgements / Благодарности

This guide is based on the TPOT Framework contribution guide.

Данный гайд основан на руководстве по вкладу в TPOT Framework.