跳到正文
cccskills
免费在 GitHub 公开

Readme standards

Conventions to use in Readme files

中文简介正在准备中。当前显示原文说明。

实测评分 未实测

查看安装方法

包含的文件(1)

  • SKILL.md3.8 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

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 / 1000 字

此表单受 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 的全部技能

报告此技能的问题