Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Привести в порядок user service #11

Open
AlIld opened this issue Nov 10, 2021 · 0 comments
Open

Привести в порядок user service #11

AlIld opened this issue Nov 10, 2021 · 0 comments
Assignees

Comments

@AlIld
Copy link

AlIld commented Nov 10, 2021

Вам нужно привести в порядок свои репозитории, то есть отредактировать readme, перенести всё в мастер, доделать правки по личным комментариям от Олега.
По просьбе закидываю пример проекта с хорошим README
https://github.com/provectus/kafka-ui

В хорошем README должны быть описаны все необходимые технологии с командами для установки и необходимые настройки среды для развертывания проекта на чистой машине.
В идеале это должно быть описано для каждой и систем Linux, MacOS, Windows
Также должно содержаться базовое описание проекта и его особенностей, чтобы пользователь имел понимание с чем он работает, своего рода микродокументация.
И в целом нужно описать все моменты на которые должен обратить внимание пользователь, чтобы ему не приходилось искать ответы на вопросы в коде.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants