The Design Guide

A simple design guide for everything related to Git and Github

About This Project

This project is here to help you get inspired and learn how to make your README files and other project content look better. It gives you ideas and tips that can be really helpful, but you don't have to do everything exactly as it says.

Feel free to:

• Use this guide as a starting point for your own creativity.
• Adapt the suggestions to match your project's unique style.
• Contribute to this project if you see something that can be improved or added

Categories

Markdown

Here is the source of the following information

Headings

  
# A first-level heading

## A second-level heading

### A third-level heading

A first-level heading

A second-level heading

A third-level heading

Text formatting

  
**This is bold text**
This is bold text


_This text is italicized_
This text is italicized


~~This was mistaken text~~
This was mistaken text  

  
> Text that is a quote
Text that is a quote

Colors

Note
Color visualization is supported only in Issues, Pull Requests and Discussions.

`#0969DA`
`rgb(9, 105, 218)`
`hsl(212, 92%, 45%)`
 

Links

  
[This is a link](https://github.com/MaximFiedler/DesignGuide)
This is a link

[License of this project](LICENSE)
License of this project
Relative link

Lists

    
- First list item
- Second list item
- Third list item

First list item
Second list item
Third list item

TODO Lists

    
- [x] A todo which is done
- [ ] An issue https://github.com/MaximFiedler/HologramAPI/issues/1


 A todo which is done
 An issue max1mde/HologramAPI#1

Highlight "Note", "Important" and "Warning" blockquotes

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.

[!NOTE]
Highlights information that users should take into account, even when skimming.

[!TIP] Optional information to help a user be more successful.

[!IMPORTANT]
Crucial information necessary for users to succeed.

[!WARNING]
Critical content demanding immediate user attention due to potential risks.

[!CAUTION] Negative potential consequences of an action.

Emojies

icon	shortcode	icon	shortcode
😄	:grinning:	😃	:smiley:
😄	:smile:	😁	:grin:
😆	:laughing: :satisfied:	😅	:sweat_smile:
🤣	:rofl:	😂	:joy:
🙂	:slightly_smiling_face:	🙃	:upside_down_face:
😉	:wink:	😊	:blush:

Here you can find a list of all emojies

Repository readme

Structure

• Badges  (optional)
• Title
• Description
• Banner/Showcase of the project  (optional)
• Table of Contents (optional but good for big readme's)
• Installation
• Usage
• How to Contribute, Licence, Credits etc  (optional)

---

Badges

Badges display important details about a project, such as version, license, downloads, and ratings. These badges can be either static or dynamic and also include symbols. These small graphical elements are typically found at the top of your readme and are provided by various services like shields.io.

You can use the html image tag to display a badge:

<img alt="GitHub license" src="https://img.shields.io/github/license/MaximFiedler/DesignGuide">

You can also make them clickable by enclosing the <img> element within an <a> element, like this:

<a href="https://github.com/MaximFiedler/DesignGuide/blob/main/LICENSE">
  <img alt="GitHub license" src="https://img.shields.io/github/license/MaximFiedler/DesignGuide">
</a>

Profile readme

Nothing here yet. You can change this by opening a pull request and contributing to this project

Wiki

Nothing here yet. You can change this by opening a pull request and contributing to this project

Commits

Commit messages

Writing clear commit messages is crucial for a clean Git history

• Keep messages concise.
• Use imperative mood.
• Separate subject from body.
• Reference issues if applicable.
• Use emojis wisely.

Emojis enhance commit messages, conveying change nature visually. They provide a quick understanding.

Here's how you can use them for different changes:

• 🐛 Fixing a bug
• 📝 Updating code/documentation
• 🚀 Introducing a new feature
• 🔒 Fixing a security issue
• 🧹 Refactoring code
• 📈 Improving performance
• 🗑️ Removing code
• ↗️ Upgrading dependencies
• ↙️ Downgrading dependencies
• 📋 Adding comments
• ➕ Adding new code

For more examples of what emojies you can use in your commit messages, check out this website.