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(contributing): adjust various wording

Browse source 
nothing major, just some tweaks to read better
This commit is contained in:
Inter 2026-02-22 21:37:25 +00:00
parent c67e3de040
commit d7e543be48
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
CONTRIBUTING.md
View file

@ -1,12 +1,12 @@
# Contributing to md-badges
Thank you for taking the time to contribute to md-badges! Before you do, please take a moment to read through the guidelines and the different ways you can contribute.
Thanks for taking the time to contribute to md-badges! Before you do, take a moment to read through the guidelines and the different ways you can contribute.
> Make sure to follow the [Code of Conduct](CODE_OF_CONDUCT.md) when contributing.
## Installing locally
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.
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 the repository to your GitHub account.
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:
@ -26,7 +26,7 @@ git checkout [NAME]
You can now start working locally on the project.
When you decide you are ready to commit your changes, and want to push them to remote, run:
When you decide you are ready to commit your changes, and want to push them, run:
```bash
git add .
@ -34,20 +34,20 @@ git commit -m "✨ feat: [commit message here]"
git push
```
> While not strictly required, it's recommended to follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines for commit messages. If you would like, you could also use [Gitmoji](https://gitmoji.dev) or any other commit emoji spec.
> While not strictly required, it's recommended to follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines for commit messages. If you want, you could also use [Gitmoji](https://gitmoji.dev) or any other commit emoji spec.
You can now create a [pull request](https://github.com/inttter/md-badges/pulls) to the repository with your changes.
> [!NOTE]
> Larger pull requests that are out of scope will most likely be **rejected**. If you are unsure whether your pull request falls under this, consider [opening an issue first](https://github.com/inttter/md-badges/issues/new), under the `enhancement` label.
> Larger pull requests that are out of scope will most likely be **rejected**. If you are unsure whether your pull request falls under this, consider [opening an issue](https://github.com/inttter/md-badges/issues/new) first, under the `enhancement` label.
## Adding a badge
> Make sure you have permission from whoever or whatever you are making a badge of to add them here.
If you would like to request a badge, please create a new issue using the [badge request](https://github.com/inttter/md-badges/issues/new?assignees=inttter&labels=%F0%9F%93%9B+badge+request&projects=inttter%2Fmd-badges&template=01-badge-request.yml&title=%5BBadge+Request%5D%3A+) template. You **must** fill out all available fields. This will help to learn more about what you want added and where it would be relevant.
If you would like to request a badge, create a new issue using the [badge request](https://github.com/inttter/md-badges/issues/new?assignees=inttter&labels=%F0%9F%93%9B+badge+request&projects=inttter%2Fmd-badges&template=01-badge-request.yml&title=%5BBadge+Request%5D%3A+) template. You **must** fill out all available fields. This will help to learn more about what you want added and where it would be relevant.
If you would like 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 repository.
If you'd like to add a new badge yourself instead, then you can do so by submitting a pull request to this repository.
When you contribute a new badge, make sure that you have checked for the following:
@ -63,7 +63,7 @@ It would also help to include the issue(s) that the pull request closes if there
If the category that a badge fits into does not exist in the badge list yet, you can create a new category for it. Ensure that the category is also placed in **alphabetical order** within the [Table of Contents](README.md#table-of-contents) and the badge list itself.
The correct format for inserting badges within a table is as follows:
The correct format for inserting badges within a table is shown below:
```markdown
| Preview | Markdown Code |
@ -73,13 +73,13 @@ The correct format for inserting badges within a table is as follows:
## Reporting an issue
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/md-badges/issues).
If you encounter something that seems wrong or incorrect, check to see if it's not already an [open issue](https://github.com/inttter/md-badges/issues).
If there is no open issue for your problem, [create a new issue](https://github.com/inttter/md-badges/issues/new?assignees=&labels=%F0%9F%90%9B+bug&projects=inttter%2Fmd-badges&template=02-issue-report.yml&title=%5BBug%5D%3A+) using the bug report template. Do your best to fill out each field, preferably in as much detail as possible.
## Questions
If you have any inquiries, would like to ask for help, or have anything else that does not fit within the available templates, feel free to make a [blank issue](https://github.com/inttter/md-badges/issues/new) outside of the templates offered, with the `question` label.
If you have any inquiries, would like to ask for help, or have anything else that doesn't fit within the available templates, feel free to make a [blank issue](https://github.com/inttter/md-badges/issues/new) outside of the templates offered, with the `question` label attached.
## License