Skip to content

Commit 711a7ee

Browse files
committed
docs: update CODE_OF_CONDUCT.md, CODEBASE_STRUCTURE.md, CODING_GUIDELINES.md, CONTRIBUTING.md, and README.md for clarity and consistency
Revise the CODE_OF_CONDUCT.md to reflect the Contributor Covenant format, enhancing inclusivity and clarity. Update CODEBASE_STRUCTURE.md to provide clear descriptions of directory purposes in English. Revise CODING_GUIDELINES.md for improved readability and consistency in coding practices. Update CONTRIBUTING.md to streamline the contribution process and ensure clarity in instructions. Enhance README.md by adding details on polymorphism and clarifying language features, improving overall documentation quality.
1 parent 8817c3b commit 711a7ee

File tree

5 files changed

+214
-201
lines changed

5 files changed

+214
-201
lines changed

CODEBASE_STRUCTURE.md

Lines changed: 32 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,32 @@
1-
# Базовая структура репозитория
2-
3-
## Назначение директорий
4-
5-
### Корневая директория
6-
- **Документация проекта** - README, инструкции по сборке, руководства для разработчиков
7-
- **Конфигурация сборки** - CMakeLists.txt, вспомогательные CMake-скрипты
8-
- **Настройки инструментов** - конфигурации для форматирования, линтеров, Git
9-
- **Скрипты автоматизации** - установка зависимостей, подготовка окружения
10-
11-
### bin/
12-
- **Исполняемые файлы** - точка входа приложения
13-
- **CLI-интерфейс** - командная строка для взаимодействия с пользователем
14-
15-
### docs/
16-
- **Документация проекта** - README, инструкции по сборке, руководства для разработчиков
17-
18-
### lib/
19-
- **Основная библиотека** - ядро функциональности проекта
20-
- **UI-модуль** - пользовательский интерфейс и CLI-утилиты
21-
- **Общие компоненты** - переиспользуемые части кода. Добавляйте новые модули только в эту директорию.
22-
23-
### tests/
24-
- **Модульные тесты** - тестирование отдельных компонентов
25-
- **Интеграционные тесты** - тестирование взаимодействия между модулями
26-
- **Вспомогательные функции** - утилиты для тестирования
27-
- **Тестовые данные** - примеры и фикстуры для тестов
28-
29-
### .github/workflows/
30-
- **CI/CD конфигурация** - автоматическая сборка и тестирование
31-
- **Проверки качества кода** - статический анализ, форматирование
32-
- **Развертывание** - автоматическая публикация релизов
33-
1+
# Base Repository Structure
2+
3+
## Directory Purposes
4+
5+
### Root Directory
6+
- **Project documentation** — README, build instructions, developer guides
7+
- **Build configuration**`CMakeLists.txt`, auxiliary CMake scripts
8+
- **Tooling settings** — configurations for formatting, linters, Git
9+
- **Automation scripts** — dependency installation, environment setup
10+
11+
### `bin/`
12+
- **Executables** — application entry point
13+
- **CLI interface** — command line for user interaction
14+
15+
### `docs/`
16+
- **Project documentation** — README, build instructions, developer guides
17+
18+
### `lib/`
19+
- **Core library** — the project's core functionality
20+
- **UI module** — user interface and CLI utilities
21+
- **Shared components** — reusable code parts. Add new modules only under this directory.
22+
23+
### `tests/`
24+
- **Unit tests** — testing individual components
25+
- **Integration tests** — testing interactions between modules
26+
- **Helper functions** — utilities for testing
27+
- **Test data** — examples and fixtures for tests
28+
29+
### `.github/workflows/`
30+
- **CI/CD configuration** — automated build and testing
31+
- **Code quality checks** — static analysis, formatting
32+
- **Deployment** — automated release publishing

CODE_OF_CONDUCT.md

Lines changed: 57 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,76 @@
1-
# Кодекс поведения участников Соглашения
1+
# Contributor Covenant Code of Conduct
22

3-
## Наше обещание
3+
## Our Pledge
44

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

11-
## Наши стандарты
12+
## Our Standards
1213

13-
Примеры поведения, которое способствует созданию благоприятной среды, включают:
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
1416

15-
- Использование приветливого и инклюзивного языка
16-
- Уважительное отношение к различным точкам зрения и опыту
17-
- Изящно принимаю конструктивную критику
18-
- Сосредоточение внимания на том, что лучше для сообщества
19-
- Проявление сочувствия к другим членам сообщества
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
2022

21-
Примеры недопустимого поведения участников включают:
23+
Examples of unacceptable behavior by participants include:
2224

23-
- Использование сексуализированной лексики или образов и нежелательное сексуальное внимание или заигрывания
24-
- Троллинг, оскорбительные / уничижительные комментарии, а также личные или политические нападки
25-
- Публичное или частное преследование
26-
- Публикация частной информации других лиц, такой как физический или электронный адрес, без явного разрешения
27-
- Другое поведение, которое можно обоснованно считать неуместным в профессиональной среде.
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
2833

29-
## Наши обязанности
34+
## Our Responsibilities
3035

31-
Сопровождающие проекта несут ответственность за разъяснение стандартов приемлемого поведения и от них ожидают принятия
32-
соответствующих и справедливых корректирующих действий в ответ на любые случаи неприемлемого поведения.
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
3339

34-
Сопровождающие проекта имеют право и обязаны удалять, редактировать или отклонять комментарии, коммиты, код, правки
35-
вики, проблемы и другие материалы, которые не соответствуют настоящему Кодексу поведения, или временно или навсегда
36-
заблокировать любого участника за другое поведение, которое они считают неуместным, угрожающим, оскорбительным или
37-
вредным.
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
3845

39-
## Сфера
46+
## Scope
4047

41-
Этот Кодекс поведения применяется как в проектных, так и в общественных местах, когда человек представляет проект или
42-
его сообщество. Примеры представления проекта или сообщества включают использование официального адреса электронной
43-
почты проекта, размещение сообщений через официальную учетную запись в социальных сетях или выполнение функций
44-
назначенного представителя на онлайн- или офлайн-мероприятии. Представление проекта может быть дополнительно определено
45-
и уточнено сопровождающими проекта.
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
4654

47-
## Исполнение
55+
## Enforcement
4856

49-
О случаях оскорбления, преследования или иного недопустимого поведения можно сообщить, связавшись с командой проекта по
50-
адресу [bigulov.sasha@gmail.com](mailto:bigulov.sasha@gmail.com). Все жалобы будут рассмотрены и исследованы, и в результате будет дан ответ, который будет
51-
сочтен необходимым и соответствующим обстоятельствам. Команда проекта обязана сохранять конфиденциальность в отношении
52-
лица, сообщившего об инциденте. Более подробная информация о конкретных правилах применения может быть опубликована
53-
отдельно.
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at kylelobo20@gmail.com. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
5463

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

58-
## Атрибуция
68+
## Attribution
5969

60-
Этот Кодекс поведения адаптирован из [Соглашения для авторов], версия 1.4, доступного по
61-
адресу https://www.contributor-covenant.org/version/1/4/code-of-conduct.html.
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
6272

63-
Ответы на распространенные вопросы об этом кодексе поведения см. https://www.contributor-covenant.org/faq.
73+
[homepage]: https://www.contributor-covenant.org
6474

65-
66-
[Соглашения для авторов]: https://www.contributor-covenant.org
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

0 commit comments

Comments
 (0)