cryptoadvocate/cryptohackappМобильная инженерная база проекта Cryptohack Badge.
Чтобы упростить начало работы с GitLab, вот список рекомендуемых дальнейших шагов.
Уже профи? Просто отредактируйте этот README.md и сделайте его своим. Хотите упростить? Используйте шаблон внизу!
cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/cryptohackapp.git
git branch -M main
git push -uf origin main
Используйте встроенную непрерывную интеграцию в GitLab.
Когда будете готовы сделать этот README своим, просто отредактируйте этот файл и используйте удобный шаблон ниже (или структурируйте его как хотите — это лишь отправная точка!). Спасибо makeareadme.com за этот шаблон.
Каждый проект уникален, поэтому подумайте, какие из этих разделов применимы к вашему. Разделы, используемые в шаблоне, являются рекомендациями для большинства проектов с открытым исходным кодом. Также имейте в виду, что хотя README может быть слишком длинным и подробным, лучше быть слишком длинным, чем слишком коротким. Если вы считаете, что ваш README слишком длинный, рассмотрите возможность использования другой формы документации вместо того, чтобы вырезать информацию.
Выберите говорящее название для вашего проекта.
Дайте людям понять, что именно может делать ваш проект. Предоставьте контекст и добавьте ссылку на любые справочные материалы, которые могут быть незнакомы посетителям. Здесь также можно добавить список функций или подраздел «Предыстория». Если есть альтернативы вашему проекту, это хорошее место для перечисления отличительных факторов.
В некоторых README вы можете увидеть небольшие изображения, которые передают метаданные, например, проходят ли все тесты для проекта. Вы можете использовать Shields, чтобы добавить их в свой README. Многие сервисы также имеют инструкции по добавлению значка.
В зависимости от того, что вы делаете, может быть хорошей идеей включить скриншоты или даже видео (часто вы увидите GIF-анимации, а не настоящие видео). Такие инструменты, как ttygif, могут помочь, но для более сложного метода ознакомьтесь с Asciinema.
В конкретной экосистеме может быть распространенный способ установки вещей, например, с помощью Yarn, NuGet или Homebrew. Однако учтите возможность, что читающий ваш README новичок и хочет получить больше руководств. Перечисление конкретных шагов помогает устранить неоднозначность и позволяет людям начать использовать ваш проект как можно быстрее. Если он работает только в определенном контексте, например, в конкретной версии языка программирования или операционной системе, или имеет зависимости, которые необходимо установить вручную, также добавьте подраздел «Требования».
Щедро используйте примеры и, по возможности, показывайте ожидаемый результат. Полезно встроить самый маленький пример использования, который вы можете продемонстрировать, и предоставить ссылки на более сложные примеры, если они слишком длинные, чтобы разумно включить их в README.
Сообщите людям, куда они могут обратиться за помощью. Это может быть любая комбинация трекера задач, чата, адреса электронной почты и т. д.
Если у вас есть идеи для будущих релизов, хорошей идеей будет перечислить их в README.
Укажите, открыты ли вы для вклада, и каковы ваши требования для его принятия.
Для людей, которые хотят внести изменения в ваш проект, полезно иметь некоторую документацию о том, как начать. Возможно, есть скрипт, который они должны запустить, или переменные окружения, которые нужно установить. Сделайте эти шаги явными. Эти инструкции также могут быть полезны вам в будущем.
Вы также можете задокументировать команды для линтинга кода или запуска тестов. Эти шаги помогают обеспечить высокое качество кода и снизить вероятность того, что изменения случайно что-то сломают. Наличие инструкций по запуску тестов особенно полезно, если требуется внешняя настройка, например запуск сервера Selenium для тестирования в браузере.
Выразите признательность тем, кто внес вклад в проект.
Для проектов с открытым исходным кодом укажите, как он лицензирован.
Если у вас закончились силы или время для вашего проекта, поместите заметку в верхней части README о том, что разработка замедлилась или полностью остановлена. Кто-то может решить форкнуть ваш проект или вызваться стать мэйнтейнером или владельцем, что позволит вашему проекту продолжить существование. Вы также можете явно запросить мэйнтейнеров.