Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/pr-labeler.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
new-badge: ['new/*', 'badge/*']
new-badge: ["new/*", "badge/*"]
new-section: section/*
typo-fix: fixed/*
35 changes: 19 additions & 16 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
## Description
<!-- Render is a .... -->

## Info
<!-- This is an example. Replace with badge details-->
| Name | Category | Background Color | Logo Color |
|:--:|:--:|:--:|:--:|
| Quill | ORM | `#52B0E7` | `#ffffff` |


## Preview
<!-- This is an example. Replace with badge url-->
| Badge | url |
| ----- | --- |
| ![Cisco](https://img.shields.io/badge/cisco-%23049fd9.svg?style=for-the-badge&logo=cisco&logoColor=black) | `![Cisco](https://img.shields.io/badge/cisco-%23049fd9.svg?style=for-the-badge&logo=cisco&logoColor=black)` |

## Description

<!-- Render is a .... -->

## Info

<!-- This is an example. Replace with badge details-->

| Name | Category | Background Color | Logo Color |
| :---: | :------: | :--------------: | :--------: |
| Quill | ORM | `#52B0E7` | `#ffffff` |

## Preview

<!-- This is an example. Replace with badge url-->

| Badge | url |
| --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| ![Cisco](https://img.shields.io/badge/cisco-%23049fd9.svg?style=for-the-badge&logo=cisco&logoColor=black) | `![Cisco](https://img.shields.io/badge/cisco-%23049fd9.svg?style=for-the-badge&logo=cisco&logoColor=black)` |
4 changes: 2 additions & 2 deletions .github/workflows/badge-order.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: 📋 Check Badge List Alphabetical Order
on:
pull_request:
paths:
- 'README.md'
- "README.md"

jobs:
check-badge-order:
Expand All @@ -15,7 +15,7 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
python-version: "3.x"

- name: Check badge list order
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr-labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ jobs:
with:
configuration-path: .github/pr-labeler.yml # optional, .github/pr-labeler.yml is the default value
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4 changes: 2 additions & 2 deletions .github/workflows/prettier.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: 🎨 Check Markdown Formatting
on:
pull_request:
paths:
- '**.md'
- "**.md"

jobs:
prettier:
Expand All @@ -15,7 +15,7 @@ jobs:
- name: Set up Node.js
uses: actions/setup-node@v6
with:
node-version: '24'
node-version: "24"

- name: Install Prettier
run: npm install -g prettier
Expand Down
12 changes: 5 additions & 7 deletions .unibeautifyrc.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
{
"Markdown": {
"beautifiers": [
"Prettier"
],
"__pragma_insert__": true,
"wrap_line_length": 0
}
"Markdown": {
"beautifiers": ["Prettier"],
"__pragma_insert__": true,
"wrap_line_length": 0
}
}
20 changes: 12 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,23 @@
`![Badge Name](https://img.shields.io/badge/<badge>-%23<badge-color>.svg?style=for-the-badge&logo=<badge>&logoColor=<logo-color>)`

> **:bulb: Tip:** Some icons/logos may not fit in the badge nicely. Add `&logoSize=auto` to the markdown's URL to help with this:

`![Badge Name](https://img.shields.io/badge/<badge>-%23<badge-color>.svg?style=for-the-badge&logo=<badge>&logoColor=<logo-color>)&logoSize=auto`

5. Replace the following: `<badge>` , `<badge-color>` , `<logo-color>`

> **:fire: Important:** All of the badges are ordered alphabetically. Hence, while contributing, make sure to order to add the new badges in an alphabetical order.
4. Replace the following: `<badge>` , `<badge-color>` , `<logo-color>`

> **:fire: Important:** All of the badges are ordered alphabetically. Hence, while contributing, make sure to order to add the new badges in an alphabetical order.

> **:bulb: Tip:** You can check available icons for your `<badge>` in [Simple Icons slugs](https://github.com/simple-icons/simple-icons/blob/develop/slugs.md) or [Simple Icons website](https://simpleicons.org/).
> **:bulb: Tip:** You can check available icons for your `<badge>` in [Simple Icons slugs](https://github.com/simple-icons/simple-icons/blob/develop/slugs.md) or [Simple Icons website](https://simpleicons.org/).

6. Create a [Pull Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request) with your proposed changes.
5. Create a [Pull Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request) with your proposed changes.

Yayyy, You are all done with the steps! Now just sit back and watch while your Pull request is reviewed and ultimately merged. 🎊

<hr />

## 🖋️ When thinking of where to add your badge:

Favor general, i.e. widely known, categories rather than specific (sometimes unknown) categories, so that it is easier to find. For instance, when a person thinks of Tor Browser, they'd want to find it where other browsers are listed.

Similarly, we have several Google products (Play, Drive, Chrome, etc), however, they are not listed under a category for Google.
Expand All @@ -38,18 +39,21 @@ So, instead of a category titled **Google** for instance, Chrome would be placed
Having the categories based on `who they are` will quickly become clumsy. And clumsy doesn't feel right.

## 🖋️ When your badge doesn't fit into any of the existing categories:
We've covered lots of ground and categories but if you find that your new badge doesn't fit into an existing category, create a new one. It would be lovely having a new category around.

We've covered lots of ground and categories but if you find that your new badge doesn't fit into an existing category, create a new one. It would be lovely having a new category around.

Some Guidelines for starting a new category:

- Check the existing categories one more time to be really sure your new badge won't fit into one. 😄
- Use a simple title. For example, instead of `Banks and money companies`, use `Finance`
- Use a title that obeys the `what they do` principle above.
- Place your shiny new category in the right alphabetical position.

## 🖋️ What to do if your badge text needs spaces:

If the badge name needs to have spaces in it ("Google Chrome", "Google Drive", "Read The Docs", etc.) just use the `%20` URL encoding for 'space'. Here are some examples of what that looks like:
| Badge (no space) | URL (without space encoding) | Badge (space) | URL (with space encoding) |
| ---------------- | ---------------------------- | ------------- | ------------------------- |
| ---------------- | ---------------------------- | ------------- | ------------------------- |
| ![Google Chrome](https://img.shields.io/badge/GoogleChrome-%234285F4?style=for-the-badge&logo=GoogleChrome&logoColor=white) | `![Google Chrome](https://img.shields.io/badge/GoogleChrome-%234285F4?style=for-the-badge&logo=GoogleChrome&logoColor=white)` | ![Google Chrome](https://img.shields.io/badge/Google%20Chrome-%234285F4?style=for-the-badge&logo=GoogleChrome&logoColor=white) | `![Google Chrome](https://img.shields.io/badge/Google%20Chrome-%234285F4?style=for-the-badge&logo=GoogleChrome&logoColor=white)` |

<hr />
Expand Down
Loading