mirror of
https://github.com/inttter/md-badges.git
synced 2026-05-06 10:26:57 +02:00
📚 docs(contributing): add more things to check for when adding a badge
Also reworded, adjusted some things and added a footnote about the badge logo's.
This commit is contained in:
parent
7b4e8e9dbd
commit
58d1ab1c22
2 changed files with 17 additions and 11 deletions
|
|
@ -1,6 +1,6 @@
|
|||
# Contributing to md-badges
|
||||
|
||||
Thank you for considering contributing to md-badges! Before you decide to, please take a moment to read through the guidelines and the ways you can contribute.
|
||||
Thank you for taking the time to contribute to md-badges! Before you do, please take a moment to read through the guidelines and the different ways you can contribute.
|
||||
|
||||
> Make sure to follow the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md) when contributing.
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ git branch [NAME]
|
|||
git checkout [NAME]
|
||||
```
|
||||
|
||||
You can now start working locally on the project, and when you are ready to to commit your changes and push them to remote, run:
|
||||
You can now start working locally on the project. When you decide you are ready to to commit your changes and push them to remote, run:
|
||||
|
||||
```bash
|
||||
git add .
|
||||
|
|
@ -32,7 +32,7 @@ git checkout -m "✨ feat: [commit message here]"
|
|||
git push
|
||||
```
|
||||
|
||||
> When writing commit messages, make sure to follow the [Convential Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines. If you would like, you can use [Gitmoji](https://gitmoji.dev) aswell for commit emojis.
|
||||
> When writing commit messages, make sure to follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines. If you would like, you can use [Gitmoji](https://gitmoji.dev) or any other commit emoji spec for commit emojis.
|
||||
|
||||
You can now create a [pull request](https://github.com/inttter/md-badges/pulls) to the repository with your changes.
|
||||
|
||||
|
|
@ -40,25 +40,29 @@ You can now create a [pull request](https://github.com/inttter/md-badges/pulls)
|
|||
|
||||
If you encounter something that is wrong or incorrect, please check to see if the problem is not already an [**open issue**](https://github.com/inttter/md-badges/issues).
|
||||
|
||||
If there is no open issue for your problem, [create a new issue](https://github.com/inttter/md-badges/issues/new?assignees=inttter&labels=%F0%9F%93%9B+badge+request&projects=inttter%2Fmd-badges&template=01-badge-request.yml&title=%5BBadge+Request%5D%3A+) using the bug report template. Do your best to fill out each field, preferably in as much detail as possible, if applicable.
|
||||
If there is no open issue for your problem, [create a new issue](https://github.com/inttter/md-badges/issues/new?assignees=&labels=%F0%9F%90%9B+bug&projects=inttter%2Fmd-badges&template=02-issue-report.yml&title=%5BBug%5D%3A+) using the bug report template. Do your best to fill out each field, preferably in as much detail as possible.
|
||||
|
||||
## Adding a badge
|
||||
|
||||
> Make sure you have permission from whoever or whatever you are making a badge of to add them here.
|
||||
|
||||
If you'd like to request a badge, please [create a new issue](https://github.com/inttter/md-badges/issues/new?assignees=inttter&labels=%F0%9F%93%9B+badge+request&projects=inttter%2Fmd-badges&template=01-badge-request.yml&title=%5BBadge+Request%5D%3A+) using the badge request template. You **must** out all available fields. This will help to learn more about what you want added and whether it would be relevant.
|
||||
If you would like to request a badge, please [create a new issue](https://github.com/inttter/md-badges/issues/new?assignees=inttter&labels=%F0%9F%93%9B+badge+request&projects=inttter%2Fmd-badges&template=01-badge-request.yml&title=%5BBadge+Request%5D%3A+) using the badge request template. You **must** out all available fields. This will help to learn more about what you want added and where it would be relevant.
|
||||
|
||||
If you want to add a new badge yourself, you can **contribute** a new badge by submitting a [pull request](https://github.com/inttter/md-badges/pulls) to the md-badges repository.
|
||||
If you would like to add a new badge yourself, you can **contribute** a new badge by submitting a [pull request](https://github.com/inttter/md-badges/pulls) to the repository.
|
||||
|
||||
When you contribute a new badge, make sure that you have checked for the following:
|
||||
|
||||
* Badge is not a **duplicate**
|
||||
* Badge is in the **correct category**
|
||||
* Badge is listed in the category in **alphabetical order**
|
||||
* Badge image appears **without any issues**
|
||||
* Badge has a **logo** [(see here)](https://github.com/inttter/mdbadges-cli/blob/main/CONTRIBUTING.md#adding-badges)
|
||||
* Badge follows the **same format** of every other badge
|
||||
* Badge code works **without any issues**
|
||||
* Badge has a **logo**[^1]
|
||||
* Badge follows the **correct format**
|
||||
|
||||
The format for inserting badges within a table is as follows:
|
||||
If the category that a badge fits into does not exist in the badge list yet, you can create a new category for it. Ensure that the category is also placed in **alphabetical order** within the [Table of Contents](README.md#table-of-contents) and the badge list itself.
|
||||
|
||||
The correct format for inserting badges within a table is as follows:
|
||||
|
||||
```markdown
|
||||
| Preview | Markdown Code |
|
||||
|
|
@ -68,8 +72,10 @@ The format for inserting badges within a table is as follows:
|
|||
|
||||
## Questions
|
||||
|
||||
If you have any inquiries, would like to ask for help, or anything else that does not fit within the available templates, feel free to make a [blank issue](https://github.com/inttter/md-badges/issues/new) outside of the templates offered.
|
||||
If you have any inquiries, would like to ask for help, or have anything else that does not fit within the available templates, feel free to make a [blank issue](https://github.com/inttter/md-badges/issues/new) outside of the templates offered.
|
||||
|
||||
## License
|
||||
|
||||
By contributing, you agree that your contributions will be licensed under the **MIT License**, which you can view [here](LICENSE). Note that companies, brands, or projects from the badges may have different licenses.
|
||||
By contributing, you agree that your contributions will be licensed under the **[MIT License](LICENSE)**. Please note that companies, brands, or projects from the badges may have **different licenses**.
|
||||
|
||||
[^1]: Shields.io uses [SimpleIcons](https://simpleicons.org) to display logo's on badges. In some cases, a logo may not have been added to SimpleIcons, or may have been removed due to other reasons. In both md-badges and mdbadges-cli, only badges **with valid logo's** are allowed to be added. This is also explained in a visual example in a disclaimer in the [mdbadges-cli Contributing Guidelines](https://github.com/inttter/mdbadges-cli/blob/main/CONTRIBUTING.md#adding-badges).
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 125 KiB |
Loading…
Add table
Add a link
Reference in a new issue