Git 자술 파일의 소스 배지
14427 단어 badgesreadmeshieldsopensource
휘장은 프로젝트의 간단명료한 정보를 보여주는 좋은 방법이다.테마와 상태 메시지를 표시하는 작은 이미지로 구성되어 있으며 다른 정보에 선택적으로 연결될 수 있습니다.그들이 소문자로 쓴 라벨처럼.일반적으로, 그것들은 자술 파일의 맨 위에 추가되며, 자술 파일은 주제 부분을 포함해야 한다.
가장 유행하는 휘장 서비스는Shields이다.그들은 맞춤형 휘장을 허용하고 방대한 동적 휘장 목록을 제공했다.후자는 코드 스타일 검사기나 다운로드 추적기와 같은 다른 서비스에서 추가 데이터를 수집합니다.하나의 큰 우세는 그들의 추적 없는 정책이다.
이 글에서, 나는 몇 개의 휘장을 보여줄 것이며, 너는 너의 소스 소프트웨어 패키지에 추가할 것을 고려할 수 있다.예는 GitHub와 PHP/Packagegist와 관련이 있지만 대부분의 언어와 플랫폼 형식은 대응하는 버전이 있습니다.
최신 버전
패키지의 최신 버전을 표시합니다.
GitHub 태그:
[](https://github.com/<USER>/<REPOSITORY>/)
Packagest 태그:
[](https://packagist.org/packages/<USER>/<PACKAGE>/)
링크는 release page, Packagist 또는 Changelog file 을 가리킬 수 있습니다.
발전
개발이 어느 지점에서 완료되었는지, 또는 최신 버전을 추가한 이래 몇 번이나 제출되었는지 표시합니다.
설명서:
[](https://github.com/<USER>/<REPOSITORY>/tree/<DEVELOPMENT BRANCH>/)
GitHub 게시 페이지:
[](https://github.com/<USER>/<REPOSITORY>/tree/<DEVELOPMENT BRANCH>/)
이 링크는 개발 지점이나 이정표 페이지를 가리킬 수 있습니다.
최신 생성 상태
최신 CI 파이핑 결과를 표시합니다.
GitHub CI 워크플로우:
[](https://github.com/<USER>/<REPOSITORY>/actions)
프로그래밍 언어
패키지에 사용되는 언어를 표시합니다.
설명서:
[](/docs/requirements/)
[](/docs/requirements/)
이 링크는 자술한 파일의 설치 안내서나 요구 사항을 가리킬 수 있습니다.패키지 저장소
패키지를 가져올 위치를 표시합니다(Packagest, NPM, RubyGems 등).
이것은 버전 표지와 결합하여 사용할 수 있다.그래서 이것은 약간의 통계 데이터를 나타낼 수 있다.
포장 업체:
[](https://packagist.org/packages/<USER>/<PACKAGE>/)
Packagegist에서 카운터 다운로드:
[](https://packagist.org/packages/<USER>/<PACKAGE>)
일부 패키지 저장소는 디스플레이 등급을 지원합니다.이것은 Packagest로서는 아직 불가능하다.
문서
문서가 중요합니다!문서에 대한 빠른 액세스를 제공합니다.
설명서:
[](https://github.com/<USER>/<REPOSITORY>/blob/master/<DOC FILE>/)
문서 읽기:
[](https://<PROJECT>.readthedocs.io/)
알림: 좋은 서비스는 Inch CI입니다. 코드의 기록 방식을 평가하고 휘장에 결과를 표시합니다.현재 JavaScript 및 Ruby만 지원됩니다.
라이센스
패키지에 대한 라이센스를 표시합니다.이것은 호환 소프트웨어 패키지를 연구할 때 매우 중요하다.
설명서:
[](https://github.com/<USER>/<REPOSITORY>/blob/master/<LICENSE FILE>)
[](https://spdx.org/licenses/GPL-2.0-or-later.html)
[](https://creativecommons.org/licenses/by-sa/3.0)
포장 업체 목록:
[](https://github.com/<USER>/<REPOSITORY>/blob/master/<LICENSE FILE>)
헌금
개원의 큰 부분은 사람들이 공헌할 가능성이다.출자자에게 어떻게 조작하는지 보여주고 출자 안내서에 링크를 추가합니다.
수동 플래그:
[](https://github.com/<USER>/<REPOSITORY>/blob/master/<CONTRIBUTION FILE>)
[](https://github.com/<USER>/<REPOSITORY>/blob/master/<CONTRIBUTION FILE>)
GitHub 기여자 카운터에서:
[](https://gitHub.com/<USER>/<REPOSITORY>/graphs/contributors/)
또 다른 기부금을 격려하는 좋은 방법은 First Timers Friendly 휘장과 표시된
first-timers-only
또는 contribute
의 문제 링크다.[](https://github.com/<USER>/<REPOSITORY>/labels/contribute)
행동 규범
프로젝트의 모든 공헌자와 보호자에게 개방적이고 환영받는 지역사회에서의 공동 이익을 보여 준다.
설명서:
[](https://github.com/<USER>/<REPOSITORY>/blob/master/<CONTRIBUTION FILE>)
유행하는 행위 준칙 템플릿은 Contributor Covenant이다.
[](<CODE OF CONDUCT FILE>)
운율학
보안, 의존성, 테스트 범위, 코드 환경 등 지표를 표시합니다.
토론
사용자가 소프트웨어 패키지를 어떻게 사용하거나 문제를 복구하는지 토론할 수 있는 곳을 제공한다.
유행하는 서비스는 GitLab에서 제공하는 서비스입니다Gitter.그것들은 모든 저장소에 공공 채팅을 제공한다.사용자는 초대 링크가 필요하지 않고 등록할 필요가 없습니다.
[](https://gitter.im/<USER>/<PROJECT>)
또 다른 선택은 게시판이나 링크 Stack Overflow 의 탭입니다.
기금
기부금, 협찬, 구독을 통해 재무적으로 지원하는 방법을 보여준다.
GitHub는 a FUNDING.yml 를 통해 여러 개의 융자 플랫폼을 추가할 수 있습니다.
설명서:
[](https://github.com/<USER>/<REPOSITORY>/blob/master/FUNDING.yml)
Liberapay:
[](https://liberapay.com/<PROJECT>/donate)
Open Collection:
[](https://opencollective.com/<USER>)
<3 개원
개원에 대한 애정을 전파하다.
설명서:
[](https://opensource.org/)
아마도 당신은 SayThanks.io 링크를 추가하고 싶을 것입니다. 이 프로젝트는 사용자가 소프트웨어 패키지를 만드는 사람에게 간단한 "감사"편지를 보내도록 격려합니다.
[](https://saythanks.io/to/<USER>)
일반 맞춤형 휘장
더 많은 정보를 추가하려면 사용자 정의 휘장을 사용하십시오.
[](https://example.com/)
동적 배지 덮어쓰기
Shields 문서에 설명된 매개 변수를 추가하여 모든 배지의 레이블, 색상, 스타일을 덮어쓸 수 있습니다.
?label=<TITLE>
?color=<HEX>
?style=flat-square
?logo=<NAME>
Reference
이 문제에 관하여(Git 자술 파일의 소스 배지), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다 https://dev.to/pixelbrackets/awesome-open-source-badges-for-your-git-readme-1cn4텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
우수한 개발자 콘텐츠 발견에 전념
(Collection and Share based on the CC Protocol.)