Willy/md-badges
1
0
Fork 0
mirror of https://github.com/inttter/md-badges.git synced 2026-05-06 10:26:57 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

🧹 chore: cleanup & update all parts of project

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

77
CONTRIBUTING.md
View file

@ -1,39 +1,72 @@
# 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
* Code implemented inside of your pull request
```bash
# 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
* 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.)
## Reporting an issue
* Check if your badges appear properly
* If not, see the [troubleshooting documentation](https://docs.inttter.com/contribution/troubleshooting) for various fixes.
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).
* 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
By contributing, you agree that your contributions will be licensed under the MIT License, which you can view [here](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.
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.