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

+ ♻️ Slightly improve contributing guidelines (#131)

Browse source
This commit is contained in:
Inter 2023-12-31 16:32:12 +00:00
parent 229a908f1f
commit 688354b9e7
1 changed files with 2 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

37
CONTRIBUTING.md
View file

@ -12,42 +12,11 @@ If you encounter anything that doesn't seem right, or that is wrong, please [ope
### Adding a badge: ### 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: 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:
* Preview of the badge * Preview of the badge
* Code implemented inside of your pull request * 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 # Pull Request Guidelines
Please ensure that you: Please ensure that you:
@ -64,9 +33,7 @@ Please ensure that you:
* Use the same format as the other badges: * Use the same format as the other badges:
| Preview | Markdown Code | ![Snippet Example](assets/snippet-example.png)
|---------|---------------|
| [![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 # License
By contributing, you agree that your contributions will be licensed under the MIT License, which you can view [here](LICENSE). By contributing, you agree that your contributions will be licensed under the MIT License, which you can view [here](LICENSE).