From 688354b9e75c97045a096352ef76de373c9a4032 Mon Sep 17 00:00:00 2001 From: Inter Date: Sun, 31 Dec 2023 16:32:12 +0000 Subject: [PATCH] =?UTF-8?q?+=20=E2=99=BB=EF=B8=8F=20Slightly=20improve=20c?= =?UTF-8?q?ontributing=20guidelines=20(#131)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 37 ++----------------------------------- 1 file changed, 2 insertions(+), 35 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b1d2e4..dc8398e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,42 +12,11 @@ If you encounter anything that doesn't seem right, or that is wrong, please [ope ### 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 * 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: @@ -64,9 +33,7 @@ Please ensure that you: * 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)](#)` | +![Snippet Example](assets/snippet-example.png) # License By contributing, you agree that your contributions will be licensed under the MIT License, which you can view [here](LICENSE).