🧹 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

1
.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,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.) 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).
* Check if your badges appear properly 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.
* If not, see the [troubleshooting documentation](https://docs.inttter.com/contribution/troubleshooting) for various fixes.
* Use the same format as the other badges: ## Adding a badge
![Snippet Example](assets/snippet-example.png) > When you add a badge, make sure you have the necessary rights from who/whatever you are making a badge of to add it.
# 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.
By contributing, you agree that your contributions will be licensed under the MIT License, which you can view [here](LICENSE).
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