Skip to content
This repository was archived by the owner on Sep 14, 2026. It is now read-only.

Commit 1eb882a

Browse files
committed
Refine project positioning
1 parent 5c1e43d commit 1eb882a

2 files changed

Lines changed: 12 additions & 12 deletions

File tree

README.en.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
[![Java](https://img.shields.io/badge/Java-21-007396)](https://adoptium.net/)
88
[![License](https://img.shields.io/badge/license-GPL--3.0-blue)](LICENSE)
99

10-
## What this project demonstrates
10+
## Capabilities
1111

1212
Network Chat is a Java 21 chat application over TCP sockets with:
1313

1414
- a resilient server with user handshake and broadcast.
1515
- a console client.
1616
- a bot client with date/time commands.
1717
- a Swing GUI client using MVC style structure.
18-
- a production-like project layout with Gradle, tests, and CI.
18+
- reproducible Gradle build, tests, CI, and quality gates.
1919

2020
![Swing GUI client](docs/images/gui-client.svg)
2121

@@ -92,25 +92,25 @@ The repository runs:
9292
- grouped dependency and workflow update signals via Dependabot,
9393
- CodeQL and OpenSSF Scorecard security scans.
9494

95-
The quality surface is intentionally structured for a public review: clean `main` surface, automated checks,
96-
and explicit licensing/operating docs.
95+
The quality surface keeps the `main` branch auditable and maintainable through automated checks,
96+
explicit licensing, and operating docs.
9797

9898
## Language
9999

100100
- English project documentation in this file.
101101
- Russian project documentation in `README.md`.
102102

103-
## Why this repository is designed for review
103+
## Maintenance model
104104

105-
This repository is organized to be review-friendly:
105+
This repository is organized for maintainability:
106106

107107
- explicit package structure,
108108
- reproducible build and command surface (`./gradlew`),
109109
- consistent protocol encoding,
110110
- targeted comments in non-trivial methods,
111111
- automated quality gates.
112112

113-
## Additional review signals
113+
## Additional quality signals
114114

115115
- Linux + Windows CI matrix for broader platform evidence.
116116
- Automated quality gates via Checkstyle, Spotless, SpotBugs and JaCoCo.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@
1111

1212
Документация на английском языке: [README.en.md](README.en.md).
1313

14-
## Что проект демонстрирует
14+
## Возможности
1515

16-
Network Chat — это Java 21 приложение для сетевого чата поверх TCP сокетов с акцентом на качество разработки:
16+
Network Chat — это Java 21 приложение для сетевого чата поверх TCP сокетов:
1717

1818
- сервер с handshake и рассылкой сообщений;
1919
- консольный клиент;
2020
- бот-клиент с командами времени/даты;
2121
- GUI клиент на Swing с разделением на MVC;
22-
- структуру продакшн-проекта с Gradle, тестами и CI.
22+
- воспроизводимая Gradle-сборка, тесты, CI и проверки качества.
2323

2424
![Swing GUI client](docs/images/gui-client.svg)
2525

@@ -64,7 +64,7 @@ Actions Summary для Linux job.
6464
- **Unit-тесты** (`src/test/java`) — протокол, bot-команды, модель GUI.
6565
- **Интеграционные тесты** (`src/integrationTest/java`) — подключение клиентов, handshake, лимиты сервера, timeout и обмен сообщениями.
6666
- **UI smoke тесты** (`src/uiTest/java`) — проверка отрисовки состояния окна чата.
67-
- **План роста** — больше негативных сценариев протокола и проверок отказоустойчивости медленных клиентов.
67+
- **План развития** — больше негативных сценариев протокола и проверок отказоустойчивости медленных клиентов.
6868

6969
Для оценки покрытия используется JaCoCo: в CI порог для ядра (`network` + `protocol`) — `80%/65%` (`line`/`branch`).
7070

@@ -95,4 +95,4 @@ Actions Summary для Linux job.
9595
## Roadmap
9696

9797
- v1.1.x: стабилизация protocol/server lifecycle, расширение негативных тестов, улучшение документации.
98-
- Позже: комнаты, история сообщений, TLS и персистентные аккаунты отдельными product-focused этапами.
98+
- Позже: комнаты, история сообщений, TLS и персистентные аккаунты отдельными функциональными этапами.

0 commit comments

Comments
 (0)