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

+ ♻️ Redid contributing guidelines (#115)

Browse source
This commit is contained in:
Inter 2023-12-29 01:05:51 +00:00
parent 1b20aab2fd
commit 34c2fecead
1 changed files with 72 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

130
CONTRIBUTING.md
View file

@ -1,58 +1,72 @@
# 🛠️ Contributing to md-badges 🛠️ # Contributing to md-badges
Thank you for considering contributing to this project! Whether it's reporting bugs, submitting feature requests, your help is much appreciated. Thank you for considering contributing to this project! Your input is valuable, whether you're reporting bugs, suggesting additions, or giving your ideas.
To contribute to this project, please follow the guidelines outlined below: However, before you do, **please** read below!
# ✨ Ways to Contribute ✨ # Ways to Contribute
Reporting Bugs: If you encounter any issues or unexpected behavior, please [open an issue](https://github.com/inttter/md-badges/issues).
### Reporting an issue/inconsistency:
Feature Requests: For new features or enhancements, please open an issue or a pull request to suggest your ideas.
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.
# 📃 Code Contributions 📃
Feel free to fork the repository and create a pull request for your proposed changes or fixes. Ensure that the code aligns with the project's standards and guidelines. ### Adding a badge:
# 🏁 Getting Started 🏁 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:
Before you start contributing, follow these steps:
* Preview of the badge
1. Fork the repository to your GitHub account. * Code implemented inside of your pull request
2. Clone the forked repository to your local machine. # Getting Started
Before you start contributing, follow these steps:
3. Create a new branch for your contributions: git checkout -b feature/your-feature.
1. Fork the repository to your GitHub account.
4. Make your changes and ensure they follow the coding standards and guidelines.
2. Clone the forked repository to your computer via:
5. Commit your changes: git commit -m '{insert a commit message here}'.
`git clone https://github.com/inttter/md-badges.git`
6. Push to your branch: git push origin feature/{name}.
3. Create a new branch for your contributions:
7. Create a pull request to the main repository.
`git branch {name goes here}`
# 📕 Pull Request Guidelines 📕
`git checkout {name goes here}`
### Pull Request Guidelines
4. Make your changes.
Please ensure your pull request adheres to the following guidelines:
5. Commit your changes:
- Make sure your badge isn't a duplicate.
`git commit -m '{insert a commit message here}'`
- They should be added in the correct category.
6. Push to your branch:
- If it fits into none of the categories already there, you are welcome to create a new category.
- Make sure the category + badge is placed in the correct alphabetical order. `git push origin {branch name}`
- Make sure your links work. 7. Publish your branch (in Visual Studio Code, you can click "Publish Branch" in Source Control after commiting the changes)
- Use the same format as already used in the code: 8. Create a pull request to the main repository.
> existing content... ℹ️ • These same steps can also be done via Visual Studio Code.
| Preview | Markdown Code | # Pull Request Guidelines
|---------|---------------|
[![Spotify](https://img.shields.io/badge/Spotify-1ED760?logo=spotify&logoColor=white)](#) | `[![Spotify](https://img.shields.io/badge/Spotify-1ED760?logo=spotify&logoColor=white)](#)` Please ensure that you:
**(essentially duplicating the Preview/Markdown code into two sections, one without the ` and one with it)** * Check to see that your badge isn't a duplicate
# ⚖️ License ⚖️ * Add the badges into the correct category
By contributing to this project, you agree that your contributions will be licensed under the [LICENSE](LICENSE) file. * If your badge doesn't fit any of the current categories, you can create a new one.
* Make sure it is an appropiate 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).