diff --git a/.gitattributes b/.gitattributes index a158744..7ecfd88 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,2 @@ -*.md linguist-detectable=true -*.md linguist-documentation=false +*.md linguist-detectable=true +*.md linguist-documentation=false \ No newline at end of file diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 6564fdc..d079d24 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,3 +1,2 @@ -ko_fi: intter -custom: ["https://www.buymeacoffee.com/intter"] -github: inttter +ko_fi: intter +github: inttter diff --git a/.github/ISSUE_TEMPLATE/badge-request.md b/.github/ISSUE_TEMPLATE/badge-request.md index 1fdbad7..49f9b36 100644 --- a/.github/ISSUE_TEMPLATE/badge-request.md +++ b/.github/ISSUE_TEMPLATE/badge-request.md @@ -1,13 +1,26 @@ --- name: Badge Request -about: Request a badge to add. -title: 'Badge Request:' -labels: 'badge request' -assignees: 'inttter' +about: Request a badge that you would like to see be added to the current badge list. +title: '[Request]:' +labels: '📛 badge request' --- -Name: +## Information + + +| Name | Category | +|--------|------------| +| [NAME] | [CATEGORY] | -Description: \ No newline at end of file +## Description + + + +## Preview + + +| Preview | Markdown Code | +|---------|---------------| +| [![GitHub](https://img.shields.io/badge/GitHub-%23121011.svg?logo=github&logoColor=white)](#) | `[![GitHub](https://img.shields.io/badge/GitHub-%23121011.svg?logo=github&logoColor=white)](#)` | \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/issue-report.md b/.github/ISSUE_TEMPLATE/issue-report.md deleted file mode 100644 index f66f73f..0000000 --- a/.github/ISSUE_TEMPLATE/issue-report.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Issue Report -about: Report an inconsistency or bug. -title: '' -labels: 'bug' -assignees: 'inttter' ---- - -Description: - - - - -Additional Context: \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/report-an-issue.md b/.github/ISSUE_TEMPLATE/report-an-issue.md new file mode 100644 index 0000000..8848ecb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/report-an-issue.md @@ -0,0 +1,18 @@ +--- +name: Report an issue +about: Report something which is bugged or not right within the repository. +title: '[Bug]:' +labels: '🐛 bug' +--- + +## Description + + + +## Example + + + +## Additional Context + + \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0b6d236..85c1aa9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,3 @@ ## Preview: - - \ No newline at end of file + \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 18c9147..7d2462b 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,128 +1,128 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, religion, or sexual identity -and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our -community include: - -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -* Focusing on what is best not just for us as individuals, but for the - overall community - -Examples of unacceptable behavior include: - -* The use of sexualized language or imagery, and sexual attention or - advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email - address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of -acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies when -an individual is officially representing the community in public spaces. -Examples of representing our community include using an official e-mail address, -posting via an official social media account, or acting as an appointed -representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -. -All complaints will be reviewed and investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the -reporter of any incident. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series -of actions. - -**Consequence**: A warning with consequences for continued behavior. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or -permanent ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an -individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within -the community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. - -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at -https://www.contributor-covenant.org/translations. +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc8398e..8d618b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,39 +1,72 @@ # 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. +Thank you for considering contributing to md-badges! Before you decide to, please take a moment to read through the guidelines and the ways you can contribute. -However, before you do, **please** read below! +> Make sure to follow the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md) when contributing. -# Ways to Contribute +## Installing locally -### Reporting an issue/inconsistency: +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. -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. +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: -### Adding a badge: +```bash +# Replace 'YOUR-USERNAME' with your GitHub username +git clone https://github.com/YOUR-USERNAME/md-badges.git +cd md-badges +``` -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: +Create a branch to work on your changes by funning these commands: -* Preview of the badge -* Code implemented inside of your pull request +```bash +# Replace '[NAME]' with the name of your branch +git branch [NAME] +git checkout [NAME] +``` -# Pull Request Guidelines +You can now start working locally on the project, and when you are ready to to commit your changes and push them to remote, run: -Please ensure that you: +```bash +git add . +git checkout -m "✨ feat: [commit message here]" +git push +``` -* Check to see that your badge isn't a duplicate +You can now create a [pull request](https://github.com/inttter/md-badges/pulls) to the repository with your changes. -* 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.) +## Reporting an issue -* Check if your badges appear properly - * If not, see the [troubleshooting documentation](https://docs.inttter.com/contribution/troubleshooting) for various fixes. +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/issues). -* Use the same format as the other badges: +If there is no open issue for your problem, [create a new issue](https://github.com/inttter/md-badges/issues/new?assignees=inttter&labels=bug&projects=&template=issue-report.md&title=) using the issue template. Describe the problem and provide any additional context. For example, your browser, device, and any screenshots. -![Snippet Example](assets/snippet-example.png) +## Adding a badge -# License -By contributing, you agree that your contributions will be licensed under the MIT License, which you can view [here](LICENSE). +> When you add a badge, make sure you have the necessary rights from who/whatever you are making a badge of to add it. + +If you'd like to request a badge, please [open an issue](https://github.com/inttter/issues) with the **'Badge Request'** template, stating the name of the badge, and a description of what the badge is about. If possible, try to include a relevant link, such as a link to the official website for it. This is helpful in order to learn more about what you want added and whether it would be relevant. + +If you want 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 md-badges repository. + +When you contribute a new badge, make sure that you have checked for the following: + +* Badge is not a **duplicate** +* Badge is in the **correct category** +* Badge image appears **without any issues** +* Badge follows the **same format** of every other badge + +The format for inserting badges within a table is as follows: + +```markdown +| Preview | Markdown Code | +|---------|---------------| +| [![Badge Name](Link)](#) | `[![Badge Name](Link)](#)` | +``` + +## Questions + +If you have any inquiries, or you would like to ask for help, feel free to make an [issue](ttps://github.com/inttter/md-badges/issues) outside of the templates offered. You will usually get a response within 1-2 days. + +## License + +By contributing, you agree that your contributions will be licensed under the **MIT License**, which you can view [here](LICENSE). Note that companies, brands, or projects from the badges may have different licenses. \ No newline at end of file diff --git a/LICENSE b/LICENSE index c730f19..e8140c6 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2024 Inter +Copyright (C) 2024 Inter Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/assets/customising.svg b/assets/customising.svg deleted file mode 100644 index d826cbe..0000000 --- a/assets/customising.svg +++ /dev/null @@ -1 +0,0 @@ -New Project \ No newline at end of file diff --git a/assets/example-badges.png b/assets/example-badges.png deleted file mode 100644 index 975c222..0000000 Binary files a/assets/example-badges.png and /dev/null differ diff --git a/assets/getting-started.svg b/assets/getting-started.svg deleted file mode 100644 index 6b0d699..0000000 --- a/assets/getting-started.svg +++ /dev/null @@ -1 +0,0 @@ -New Project \ No newline at end of file diff --git a/assets/snippet-example.png b/assets/snippet-example.png deleted file mode 100644 index f611d08..0000000 Binary files a/assets/snippet-example.png and /dev/null differ diff --git a/assets/snippet.png b/assets/snippet.png new file mode 100644 index 0000000..b15a3fa Binary files /dev/null and b/assets/snippet.png differ diff --git a/assets/styles.svg b/assets/styles.svg deleted file mode 100644 index 480501b..0000000 --- a/assets/styles.svg +++ /dev/null @@ -1 +0,0 @@ -New Project \ No newline at end of file