Skip to content
cccskills
FreePublished on GitHub

Readme standards

Conventions to use in Readme files

The English summary is being prepared. Showing the original description.

Run score Not tested

See how to install

Files included (1)

  • SKILL.md3.8 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

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.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

docker

Free

Conventions for docker

The English summary is being prepared. Showing the original description.

jesperancinha/whiskers-kotlin-native12Updated Jul 20, 2026

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

The English summary is being prepared. Showing the original description.

jesperancinha/whiskers-kotlin-native12Updated Jul 20, 2026

Conventions for using Java

The English summary is being prepared. Showing the original description.

jesperancinha/whiskers-kotlin-native12Updated Jul 20, 2026

Conventions for using in all JVM languages

The English summary is being prepared. Showing the original description.

jesperancinha/whiskers-kotlin-native12Updated Jul 20, 2026

Conventions for using Kotlin

The English summary is being prepared. Showing the original description.

jesperancinha/whiskers-kotlin-native12Updated Jul 20, 2026

ktor

Free

Conventions for Ktor Gradle modules

The English summary is being prepared. Showing the original description.

jesperancinha/whiskers-kotlin-native12Updated Jul 20, 2026

See all skills by jesperancinha

Report a problem with this skill