🧹 chore: cleanup & update all parts of project

This commit is contained in:
Inter 2024-05-14 18:23:48 +01:00
parent 7d71c4bb97
commit 3718e7d3b1
15 changed files with 226 additions and 181 deletions

4
.gitattributes vendored
View file

@ -1,2 +1,2 @@
*.md linguist-detectable=true *.md linguist-detectable=true
*.md linguist-documentation=false *.md linguist-documentation=false

5
.github/FUNDING.yml vendored
View file

@ -1,3 +1,2 @@
ko_fi: intter ko_fi: intter
custom: ["https://www.buymeacoffee.com/intter"] github: inttter
github: inttter

View file

@ -1,13 +1,26 @@
--- ---
name: Badge Request name: Badge Request
about: Request a badge to add. about: Request a badge that you would like to see be added to the current badge list.
title: 'Badge Request:' title: '[Request]:'
labels: 'badge request' labels: '📛 badge request'
assignees: 'inttter'
--- ---
Name: ## Information
<!-- Replace [NAME] with the name of your badge. -->
<!-- Replace [CATEGORY] with the category your badge goes into. -->
| Name | Category |
|--------|------------|
| [NAME] | [CATEGORY] |
Description: ## Description
<!-- Short description of the badge goes here. !-->
## Preview
<!-- Replace both with your badge. -->
| Preview | Markdown Code |
|---------|---------------|
| [![GitHub](https://img.shields.io/badge/GitHub-%23121011.svg?logo=github&logoColor=white)](#) | `[![GitHub](https://img.shields.io/badge/GitHub-%23121011.svg?logo=github&logoColor=white)](#)` |

View file

@ -1,14 +0,0 @@
---
name: Issue Report
about: Report an inconsistency or bug.
title: ''
labels: 'bug'
assignees: 'inttter'
---
<!-- Describe what the inconsistency/bug/etc was. !-->
Description:
<!-- Leave anything else in this area. !-->
Additional Context:

View file

@ -0,0 +1,18 @@
---
name: Report an issue
about: Report something which is bugged or not right within the repository.
title: '[Bug]:'
labels: '🐛 bug'
---
## Description
<!-- Enter a short description of what the problem is here. -->
## Example
<!-- Leave any code examples here. If this is not applicable for the issue, you can delete this section. -->
## Additional Context
<!-- Leave anything else, such as screenshots, in this area. If this is not applicable for this issue, you can delete this section. !-->

View file

@ -1,4 +1,3 @@
## Preview: ## Preview:
<!-- insert a preview of the badge here !--> <!-- insert a preview of the badge here !-->
<!-- make sure it is implemented in your PR !-->

View file

@ -1,128 +1,128 @@
# Contributor Covenant Code of Conduct # Contributor Covenant Code of Conduct
## Our Pledge ## Our Pledge
We as members, contributors, and leaders pledge to make participation in our We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status, identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity nationality, personal appearance, race, religion, or sexual identity
and orientation. and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community. diverse, inclusive, and healthy community.
## Our Standards ## Our Standards
Examples of behavior that contributes to a positive environment for our Examples of behavior that contributes to a positive environment for our
community include: community include:
* Demonstrating empathy and kindness toward other people * Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences * Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback * Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes, * Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience and learning from the experience
* Focusing on what is best not just for us as individuals, but for the * Focusing on what is best not just for us as individuals, but for the
overall community overall community
Examples of unacceptable behavior include: Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or * The use of sexualized language or imagery, and sexual attention or
advances of any kind advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks * Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment * Public or private harassment
* Publishing others' private information, such as a physical or email * Publishing others' private information, such as a physical or email
address, without their explicit permission address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a * Other conduct which could reasonably be considered inappropriate in a
professional setting professional setting
## Enforcement Responsibilities ## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive, response to any behavior that they deem inappropriate, threatening, offensive,
or harmful. or harmful.
Community leaders have the right and responsibility to remove, edit, or reject Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate. decisions when appropriate.
## Scope ## Scope
This Code of Conduct applies within all community spaces, and also applies when This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces. an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address, Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed posting via an official social media account, or acting as an appointed
representative at an online or offline event. representative at an online or offline event.
## Enforcement ## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at reported to the community leaders responsible for enforcement at
. .
All complaints will be reviewed and investigated promptly and fairly. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the All community leaders are obligated to respect the privacy and security of the
reporter of any incident. reporter of any incident.
## Enforcement Guidelines ## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct: the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction ### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed **Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community. unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing **Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested. behavior was inappropriate. A public apology may be requested.
### 2. Warning ### 2. Warning
**Community Impact**: A violation through a single incident or series **Community Impact**: A violation through a single incident or series
of actions. of actions.
**Consequence**: A warning with consequences for continued behavior. No **Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or like social media. Violating these terms may lead to a temporary or
permanent ban. permanent ban.
### 3. Temporary Ban ### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including **Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior. sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public **Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period. with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban. Violating these terms may lead to a permanent ban.
### 4. Permanent Ban ### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community **Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals. individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within **Consequence**: A permanent ban from any sort of public interaction within
the community. the community.
## Attribution ## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity). enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org [homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations. https://www.contributor-covenant.org/translations.

View file

@ -1,39 +1,72 @@
# Contributing to md-badges # Contributing to md-badges
Thank you for considering contributing to this project! Your input is valuable, whether you're reporting bugs, suggesting additions, or giving your ideas. 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.
However, before you do, **please** read below! > Make sure to follow the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md) when contributing.
# Ways to Contribute ## Installing locally
### Reporting an issue/inconsistency: You will need to have a local copy of the repository. To do this, fork the project locally by clicking the **'Fork'** button at the top of the repository to create a fork of md-badges to your GitHub account.
If you encounter anything that doesn't seem right, or that is wrong, please [open an issue](https://github.com/inttter/issues) and select the **"Issue Report"** template. You'll then need to clone it on your local machine. In order to do this, make sure you have [Git](https://git-scm.com) installed, then run the following commands:
### Adding a badge: ```bash
# Replace 'YOUR-USERNAME' with your GitHub username
git clone https://github.com/YOUR-USERNAME/md-badges.git
cd md-badges
```
If you'd like to request a badge, please [open an issue](https://github.com/inttter/issues) with the **"Badge Request"** template, or if you'd like to add it yourself, [open a pull request](https://github.com/inttter/pulls) with the following: Create a branch to work on your changes by funning these commands:
* Preview of the badge ```bash
* Code implemented inside of your pull request # Replace '[NAME]' with the name of your branch
git branch [NAME]
git checkout [NAME]
```
# Pull Request Guidelines 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:
Please ensure that you: ```bash
git add .
git checkout -m "✨ feat: [commit message here]"
git push
```
* Check to see that your badge isn't a duplicate You can now create a [pull request](https://github.com/inttter/md-badges/pulls) to the repository with your changes.
* Add the badges into the correct category ## Reporting an issue
* If your badge doesn't fit any of the current categories, you can create a new one.
* Make sure it is an appropriate name (ie. Games Consoles is allowed, Playstation Consoles isn't.)
* Check if your badges appear properly 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/issues).
* If not, see the [troubleshooting documentation](https://docs.inttter.com/contribution/troubleshooting) for various fixes.
* Use the same format as the other badges: If there is no open issue for your problem, [create a new issue](https://github.com/inttter/md-badges/issues/new?assignees=inttter&labels=bug&projects=&template=issue-report.md&title=) using the issue template. Describe the problem and provide any additional context. For example, your browser, device, and any screenshots.
![Snippet Example](assets/snippet-example.png) ## Adding a badge
# License > When you add a badge, make sure you have the necessary rights from who/whatever you are making a badge of to add it.
By contributing, you agree that your contributions will be licensed under the MIT License, which you can view [here](LICENSE).
If you'd like to request a badge, please [open an issue](https://github.com/inttter/issues) with the **'Badge Request'** template, stating the name of the badge, and a description of what the badge is about. If possible, try to include a relevant link, such as a link to the official website for it. This is helpful in order to learn more about what you want added and whether 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.
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 image appears **without any issues**
* Badge follows the **same format** of every other badge
The format for inserting badges within a table is as follows:
```markdown
| Preview | Markdown Code |
|---------|---------------|
| [![Badge Name](Link)](#) | `[![Badge Name](Link)](#)` |
```
## Questions
If you have any inquiries, or you would like to ask for help, feel free to make an [issue](ttps://github.com/inttter/md-badges/issues) outside of the templates offered. You will usually get a response within 1-2 days.
## 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.

View file

@ -1,6 +1,6 @@
MIT License MIT License
Copyright (c) 2024 Inter Copyright (C) 2024 Inter
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 207 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 66 KiB

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 152 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

BIN
assets/snippet.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 232 KiB

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 87 KiB