предисловие
Я делаю свой собственный в последнее времягитхаб проект, что немного украсило его в эти дни. Отсюда и эта статья. Хотя эти задания не сделают ваш проект потрясающим, но они сделают его красивым и облегчат понимание вашего проекта другими.
README
README — это первое впечатление, которое пользователи нажимают на ваш проект, и его стоит посетить.Научитесь писать ридми. Конечно, мы можем не рассматривать его полностью, лучше использовать инструменты для его генерации. рекомендоватьreadme-md-generator. Сгенерированный README выглядит следующим образом:
Logo
Первым шагом для хорошего проекта является поиск более привлекательного логотипа.Сейчас очень популярны логотипы, созданные искусственным интеллектом. Порекомендуйте несколько сайтов
- brandmark
- looka
- launchaco, это совершенно бесплатно, хотя логотип не очень нравится
- designevo, создаст для вас базовое изображение логотипа (jpg и png), если вы хотите более индивидуальные, с вас будет взиматься плата.
Badge
Внутри README мы можем добавитьЗначок, часто используемые логотипы в основном включают статус непрерывной интеграции, информацию о версии проекта, покрытие тестами кода, платформу поддержки проекта, язык проекта, анализ кода и т. д. Если вы хотите получить эти значки, вы знаете, что делать.
GITHUB PAGE
Если пользователям интересно, они могут захотеть по-настоящему прочувствовать проект. Наш фронтенд-проект не нуждается в бэкграунде, он действительно подходит для деплоя вgithub pageначальство.
Github-стример
На своей странице GITHUB вы можете добавитьGithub-стример,илиGithub Corner
GIT COMMIT
Если ваш пользователь особенно заинтересован в вашем проекте, возможно, он будет смотреть на ваш коммит и увидеть процесс вашего письма. Если информация об уступке полна бессмысленной информации, такой как Fix, Add или даже AA, DD, вы обязательно почувствуете, что автор этого проекта не особо внимательно.
Спецификация фиксации Angular
Конечно, как автор проекта, вы иногда можете быть очень ленивыми. . . . , Чтобы решить эту проблему, мы рекомендуем несколько инструментов.
- CommitizenИнструмент для написания квалифицированных сообщений Commit.
- commitlintИспользуется для проверки того, соответствует ли формату сообщение Commit проекта Node.
changelog
Если все ваши коммиты соответствуют формату Angular, то при выпуске новой версии журнал изменений может быть автоматически сгенерирован сценарием,conventional-changelogЭто инструмент для создания журнала изменений.
Ссылаться на
- Добавление и настройка значков проекта GitHub
- awesome-bookmarks
- Сообщение фиксации и руководство по написанию журнала изменений
разное
Конечно, если в вашем проекте позже будут участвовать другие люди, без шаблона вопроса и шаблона PR тоже не обойтись.
Есть ли у вас какие-нибудь необычные трюки, пожалуйста, дайте мне знать в разделе комментариев