본문으로 건너뛰기
cccskills
무료GitHub에 공개

Readme standards

Conventions to use in Readme files

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

실행 점수 미검증

설치 방법 보기

포함된 파일(1)

  • SKILL.md3.8 KB

SKILL.md(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

1. Remove the usage of unresolved anchors

Unresolved anchors that don't translate to a link or a website should be removed. The most important examples of this are the usage of (#). This used to be a guarantee that the image would be displayed. This is no longer necessary, and the svg icons get generated with or without the link.

Example 1

Replace

[![GitHub release](https://img.shields.io/github/release-pre/jesperancinha/your-finance-je.svg)](#)

with

![GitHub release](https://img.shields.io/github/release-pre/jesperancinha/your-finance-je.svg)

2. Don't use obsolete HTML properties for showing images with divs

  1. Replace usages of <div align="center"> with <div style="text-align: center;">
  2. If the alt attribute is missing from the img node, please add it with the text of the a (anchor), property value of its title property.

Example 1

Replace

<div align="center">
      <a title="Learning JWT security using KumuluzEE — The finances of a league of the environment" href="https://itnext.io/learning-jwt-security-using-kumuluzee-the-finances-of-a-league-of-the-environment-2f541e99cc90">
     <img 
          src="./docs/images/articles.your.finance.intro.png" 
          style="width:100%;">
      </a>
</div>

with

<div style="text-align: center;">
      <a title="Learning JWT security using KumuluzEE — The finances of a league of the environment" href="https://itnext.io/learning-jwt-security-using-kumuluzee-the-finances-of-a-league-of-the-environment-2f541e99cc90">
     <img 
          src="./docs/images/articles.your.finance.intro.png" 
          style="width:100%;" alt="Learning JWT security using KumuluzEE — The finances of a league of the environment">
      </a>
</div>

3. Remove obsolete badges

Some badges are no longer usable and don't work because some of the frameworks they used have been discontinued. For all .md files, or other markdown files, please remove badges from the following list:

  1. codebeat badge - All codebeat badges should be removed, along with any references to using it.
  2. BCH compliance - All BCH badges should be removed, along with any references to using it.

4. .md files in Submodules, or subfolders, should not contain any of the following badges

The following badges are applied to the whole project, hence why it makes no sense to keep them in submodules or subfolders. These badges should only be part of root Readme.md files. They should also be removed from other .md files if found.

  1. Twitter URL]()
  2. Generic badge]()
  3. GitHub release]()
  4. GitHub License]()
  5. CircleCI]()
  6. Build status]()
  7. jeorg-spring-master-test-drives](https://github.com/jesperancinha/jeorg-spring-master-test-drives/actions/workflows/jeorg-spring-master-test-drives.yml)
  8. Codacy Badge]()
  9. codebeat badge]()
  10. BCH compliance]()
  11. Known Vulnerabilities]()
  12. Codacy Badge]()
  13. Coverage Status]()
  14. codecov]()
  15. GitHub language count]()
  16. GitHub top language]()
  17. GitHub top language]()

The pipeline GitHub action badges usually have the name of the project. They usually have actions/workflows in the links. These should only be part of root Readme.md files. They should also be removed from other .md files if found.

5. Please remove emojis from badges

There may be other badges with emojis in their presentation text. Most of these bages are the Generic one:

Generic badge

Look for these badges and simply remove the emoji from the presentation text, if any is found.

리뷰

아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.

댓글

로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.

아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.

보내면 바로 공개됩니다. 이메일 주소나 전화번호 같은 개인 정보는 쓰지 마세요. URL은 2개까지입니다.

0 / 1,000자

이 양식은 reCAPTCHA로 보호되며 Google 개인정보처리방침 및 서비스 약관이 적용됩니다.

같은 저장소의 스킬

docker

무료

Conventions for docker

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

jesperancinha/whiskers-kotlin-native122026년 7월 20일 업데이트

Conventions for using in all JEE frameworks. These are common standards for CDI

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

jesperancinha/whiskers-kotlin-native122026년 7월 20일 업데이트

Conventions for using Java

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

jesperancinha/whiskers-kotlin-native122026년 7월 20일 업데이트

Conventions for using in all JVM languages

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

jesperancinha/whiskers-kotlin-native122026년 7월 20일 업데이트

Conventions for using Kotlin

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

jesperancinha/whiskers-kotlin-native122026년 7월 20일 업데이트

ktor

무료

Conventions for Ktor Gradle modules

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

jesperancinha/whiskers-kotlin-native122026년 7월 20일 업데이트

jesperancinha의 스킬 모두 보기

이 스킬의 문제 신고