Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 27 additions & 50 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,46 @@
# Contributor Covenant Code of Conduct
# Кодекс поведения сообщества

## Our Pledge
## Наше обязательство

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
Мы, участники и сопровождающие проекта, стремимся поддерживать открытое и дружелюбное сообщество. Для каждого участие в проекте должно быть безопасным и уважительным вне зависимости от возраста, внешности, инвалидности, этнической принадлежности, гендерной идентичности, уровня опыта, образования, социального статуса, национальности, расы, религии и сексуальной ориентации.

## Our Standards
## Нормы поведения

Examples of behavior that contributes to creating a positive environment
include:
Мы приветствуем:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
- уважительную и инклюзивную коммуникацию;
- внимательное отношение к разным мнениям и опыту;
- спокойное принятие конструктивной критики;
- фокус на пользе для сообщества;
- эмпатию и взаимную поддержку.

Examples of unacceptable behavior by participants include:
Недопустимо:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
- сексуализированные высказывания и нежелательное внимание;
- троллинг, оскорбления, уничижительные комментарии, личные или политические атаки;
- публичные или приватные формы преследования;
- публикация личной информации других людей без явного согласия;
- любое поведение, которое разумно считается неприемлемым в профессиональной среде.

## Our Responsibilities
## Ответственность сопровождающих

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Сопровождающие проекта отвечают за разъяснение стандартов поведения и вправе предпринимать справедливые корректирующие меры в ответ на нарушения.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
Они могут удалять, редактировать или отклонять комментарии, коммиты, код, правки в wiki, issues и другие вклады, не соответствующие данному Кодексу поведения, а также временно или постоянно ограничивать участие нарушителей.

## Scope
## Область действия

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.
Кодекс действует во всех пространствах проекта, а также в публичных ситуациях, где участник представляет проект или сообщество (например, при использовании официальной почты, аккаунтов в соцсетях или во время онлайн/оффлайн-мероприятий).

## Enforcement
## Применение

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
Если сопровождающий не следует этому Кодексу поведения или применяет его недобросовестно, к нему также могут быть применены меры со стороны руководства проекта.

## Attribution
## Источник

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
Документ адаптирован из [Contributor Covenant][homepage], версия 1.4:
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
Ответы на частые вопросы: https://www.contributor-covenant.org/faq
60 changes: 23 additions & 37 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,54 @@
# Contributing to Multi-Agent
# Вклад в Multi-Agent

We welcome you to [check the existing issues](https://github.com/Tecevik/Multi-Agent/issues) for bugs or enhancements to work on.
If you have an idea for an extension to Multi-Agent, please [file a new issue](https://github.com/Tecevik/Multi-Agent/issues/new) so we can discuss it.
Будем рады вашему участию в развитии проекта!

Make sure to familiarize yourself with the project layout before making any major contributions.
- Посмотрите [открытые issues](https://github.com/Tecevik/Multi-Agent/issues), где можно помочь с багами и улучшениями.
- Если у вас есть идея, создайте [новый issue](https://github.com/Tecevik/Multi-Agent/issues/new), чтобы обсудить её до реализации.

## How to contribute
Перед крупными изменениями рекомендуем ознакомиться со структурой проекта.

1. Fork the [project repository](https://github.com/Tecevik/Multi-Agent/): click on the 'Fork' button near the top of the page. This creates a copy of the code under your account on the GitHub server.
## Как внести вклад

2. Clone this copy to your local disk:
1. Сделайте форк репозитория.
2. Клонируйте форк локально:

```bash
git clone git@github.com:YourUsername/Multi-Agent.git
```

3. Create a branch to hold your changes:
3. Создайте отдельную ветку:

```bash
git checkout -b my-contribution
```

4. Make sure your local environment is correctly set up for development and that all required project dependencies are installed.

5. Start making changes on your newly created branch, remembering to
never work on the ``master`` branch! Work on this copy on your
computer using Git to do the version control.

6. To check that your changes haven’t broken existing tests and that new tests pass, run the tests.

7. When you're done editing and local testing, run:
4. Убедитесь, что локальное окружение настроено, а зависимости установлены.
5. Вносите изменения только в своей ветке (не работайте напрямую в `master/main`).
6. Прогоните локальные проверки и убедитесь, что ничего не сломано.
7. Сохраните изменения:

```bash
git add modified_files
git commit
```

to record your changes in Git, then push them to GitHub with:
8. Отправьте ветку в свой форк:

```bash
git push -u origin my-contribution
```

Finally, go to the web page of your fork of the Multi-Agent repo, and click
'Pull Request' (PR) to send your changes to the maintainers for review.

When creating your PR, please make sure to enable the "Allow edits from maintainers" option (known as maintainer_can_modify).
This allows the maintainers to make minor changes or improvements to your PR branch if necessary during the review process.

(If it looks confusing to you, then look up the [Git
documentation](http://git-scm.com/documentation) on the web.)

## Before submitting your pull request

Before you submit a pull request for your contribution, please work
through this checklist to make sure that you have done everything
necessary so we can efficiently review and accept your changes.
9. Откройте Pull Request из форка в основной репозиторий.

If your contribution changes Multi-Agent in any way:
При создании PR включите опцию **Allow edits from maintainers** (`maintainer_can_modify`), чтобы сопровождающие могли вносить небольшие правки в вашу ветку во время ревью.

If your contribution involves any code changes:
## Перед отправкой Pull Request

- Make sure that your code is properly commented with [docstrings](https://peps.python.org/pep-0257/) and comments explaining your rationale behind non-obvious coding practices.
Если ваш вклад затрагивает код:
- добавьте понятные docstring/комментарии там, где логика неочевидна;
- убедитесь, что изменения отражены в документации (если требуется);
- убедитесь, что локальные проверки пройдены.

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

This document guide is based at well-written contributung guide of [TPOT](https://github.com/EpistasisLab/tpot) and [FEDOT](https://github.com/aimclub/FEDOT) frameworks.
Этот гайд вдохновлён практиками проектов [TPOT](https://github.com/EpistasisLab/tpot) и [FEDOT](https://github.com/aimclub/FEDOT).
34 changes: 15 additions & 19 deletions .github/ISSUE_TEMPLATE/BUG_ISSUE.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,28 @@
---
name: Bug report
about: Is something not working as expected?
name: Сообщение о баге
about: Что-то работает не так, как ожидалось?
title: "[Bug]: "
labels: bug
assignees: ''

---

Hi! Thank you for taking the time to report a bug with Multi-Agent.
Спасибо, что нашли время сообщить о проблеме в Multi-Agent!

Additionally, please note that this platform is meant for bugs in Multi-Agent only.
Issues regarding dependencies and libraries should be reported in their respective repositories.
Пожалуйста, используйте этот шаблон только для ошибок самого проекта Multi-Agent.
Проблемы зависимостей и сторонних библиотек лучше создавать в их репозиториях.

<!--- Provide a general summary of the issue in the Title above -->
## Ожидаемое поведение
<!-- Как система должна была работать? -->

## Expected Behavior
<!--- If you're suggesting a change/improvement, tell us how it should work -->
## Текущее поведение
<!-- Что происходит сейчас? -->

## Current Behavior
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
## Возможное решение
<!-- Необязательно: предложите идею исправления -->

## Possible Solution
<!--- Not obligatory, but suggest a fix/reason -->
<!--- or ideas how to implement the addition or change -->
## Шаги для воспроизведения
<!-- Опишите последовательность действий -->

## Steps to Reproduce
<!--- Provide a link to a live example -->

## Context [OPTIONAL]
<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
## Контекст [необязательно]
<!-- Как это влияет на вашу работу? -->
66 changes: 21 additions & 45 deletions .github/ISSUE_TEMPLATE/FEATURE_ISSUE.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,44 @@
---
name: Feature request
about: Want us to add any features to Multi-Agent?
name: Запрос функциональности
about: Хотите предложить новую возможность для Multi-Agent?
title: 'enh: '
labels: enhancement
assignees: ''

---

<!--
Hi! Thanks for considering to file a feature request with Multi-Agent. Please take the time to
answer the basic questions. Please try to be as detailed as possible.

Thanks!
-->
Спасибо за идею по развитию Multi-Agent! Постарайтесь описать предложение как можно конкретнее.

## Summary
## Краткое описание

<!--
A one-paragraph explanation of the feature.
-->
<!-- Коротко: что именно вы предлагаете? -->

## Motivation
## Мотивация

<!--
Why do you want to see this feature in Multi-Agent? What use cases does it support?
-->
<!-- Зачем нужна эта функциональность и какие use case она покрывает? -->

## Guide-level explanation
## Объяснение на пользовательском уровне

<!--
Explain the proposal as if it was already included in the project and you
were teaching it to another programmer. That generally means:

- Introducing new named concepts.
- Explaining the feature largely in terms of examples.
- If applicable, provide sample error messages, deprecation warnings, or
migration guidance.

If this is a small feature, you may omit this section.
Опишите фичу так, как будто она уже есть в проекте:
- какие новые понятия вводятся;
- как этим пользоваться;
- какие сценарии закрывает.
-->

## Reference-level explanation
## Техническое объяснение

<!--
This is the technical portion of the feature request. Explain the design in
sufficient detail that:

- Its interaction with other features is clear.
- It is reasonably clear how the feature would be implemented.
- Corner cases are dissected by example.

If you do not know how to answer this, you can omit it. No worries!
Если можете, добавьте технические детали:
- взаимодействие с текущими частями системы;
- предполагаемый способ реализации;
- важные edge cases.
-->

## Drawbacks
## Недостатки

<!--
Why should we *not* do this?
-->
<!-- Какие компромиссы или минусы у предложения? -->

## Unresolved Questions
## Открытые вопросы

<!--
What related issues do you consider out of scope for this feature that could be
addressed in the future independently of the solution that comes out of this
feature?
-->
<!-- Что остаётся за рамками предложения и может быть решено позже? -->
Loading