# 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.

However, before you do, **please** read below!

# Ways to Contribute 

### Reporting an issue/inconsistency: 

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.

### Adding a badge:

If you'd like to add a badge, please [open an issue](https://github.com/inttter/issues) (if you do not want to add it yourself) or [open a pull request](https://github.com/inttter/pulls) with the following:

* Preview of the badge
* Code implemented inside of your pull request

# Getting Started
Before you start contributing, follow these steps:

1. Fork the repository to your GitHub account.

2. Clone the forked repository to your computer via:

    `git clone https://github.com/inttter/md-badges.git`

3. Create a new branch for your contributions: 

    `git branch {name goes here}`
    
    `git checkout {name goes here}` 

4. Make your changes.

5. Commit your changes: 
    
    `git commit -m '{insert a commit message here}'`

6. Push to your branch: 

    `git push origin {branch name}`

7. Publish your branch (in Visual Studio Code, you can click "Publish Branch" in Source Control after commiting the changes)

8. Create a pull request to the main repository.

ℹ️ • These same steps can also be done via Visual Studio Code.

# Pull Request Guidelines

Please ensure that you:

* Check to see that your badge isn't a duplicate

* 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.)

* Check if your badges appear properly
    * If not, see the [troubleshooting documentation](https://docs.inttter.com/contribution/troubleshooting) for various fixes.

* Use the same format as the other badges:

| Preview | Markdown Code |
|---------|---------------|
| [![Spotify](https://img.shields.io/badge/Spotify-1ED760?logo=spotify&logoColor=white)](#) | `[![Spotify](https://img.shields.io/badge/Spotify-1ED760?logo=spotify&logoColor=white)](#)` |

# License 
By contributing, you agree that your contributions will be licensed under the MIT License, which you can view [here](LICENSE).