mirror/dashboard-icons
1
0
Fork 0
mirror of https://github.com/walkxcode/dashboard-icons.git synced 2025-11-18 01:27:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

🚀 Much needed maintenance

Browse Source
This commit is contained in:
Bjorn Lammers
2024-10-20 19:24:03 +02:00
parent 8d414fa3ef
commit 442e8f9d77
4993 changed files with 53535 additions and 3548 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
CONTRIBUTING.md
View File

@@ -1,50 +1,78 @@
# 🤝 Contribution Guidelines
![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?style=flat-square)
We appreciate your interest in contributing to our icon repository! To ensure smooth collaboration, kindly adhere to the following guidelines:
## Contribution Guidelines
## 🌟 Icon Specifications
Thank you for your interest in contributing to the icon repository! To ensure smooth collaboration, please follow these guidelines. Your contributions help make this project better.
- Icons should be provided in both `PNG` and `SVG` formats. Other formats like `JPEG` or `WEBP` will not be accepted.
- In cases where an `SVG` version is unavailable, a `PNG` version alone suffices.
- Conversely, if a `PNG` version is missing, it can be generated using [Ezgif SVG to PNG](#-converting-svg-to-png).
- `PNG`s should maintain a height of exactly `512px`, while width can vary. However, a 1:1 aspect ratio is preferred.
- ❗ Avoid upscales! Exceptions will be made only if the correct or a downscaled version cannot be obtained.
- Downsizing can be accomplished using [iLoveIMG Resize](#-downscaling-pngs).
- Icons should be named using the [Kebab Case](https://wiki.c2.com/?KebabCase) convention, reflecting their full name. For instance, "Facebook Messenger" should be named `facebook-messenger.png`.
- Icons that are predominantly monochrome should default to a dark version. Light versions should be named `name-light.png`. If a light version is not available, use [https://pinetools.com/colorize-image](https://pinetools.com/colorize-image) to adjust its color.
## Table of Contents
## 💻 Gitmoji Commits
- [Contribution Guidelines](#contribution-guidelines)
- [Table of Contents](#table-of-contents)
- [Icon Specifications](#icon-specifications)
- [Format](#format)
- [Cropping](#cropping)
- [Light and Dark Versions](#light-and-dark-versions)
- [File Naming](#file-naming)
- [Quality Requirements](#quality-requirements)
- [Git Commit Messages](#git-commit-messages)
- [Contribution Process](#contribution-process)
- [Code of Conduct](#code-of-conduct)
- [Contact](#contact)
- Use [Gitmoji](https://gitmoji.dev/) in your commit messages. This helps us keep our commit history clear and easy to understand. For instance, use the `🍱` emoji for commits related to updating icon colors, and `📝` for documentation updates.
## Icon Specifications
## 🔀 Converting SVG to PNG
### Format
1. Go to https://ezgif.com/svg-to-png.
2. Upload the `SVG` file by clicking "Upload".
3. Set the "Height (optional)" field to `512`, leaving other settings as default.
4. Click "Convert to PNG!".
5. Click "Save" located at the bottom right under the converted image.
- **SVG Format Required**: All icons must be submitted in SVG format.
- **Automatic PNG and WEBP Generation**: PNG and WEBP versions are generated automatically from the SVG files using the following settings:
- **Dimensions**:
- Height: 512 pixels
- Width: Auto (maintaining aspect ratio)
- **Transparency**: Enabled
## ⤵️ Downscaling PNGs
### Cropping
1. Go to https://www.iloveimg.com/resize-image.
2. Upload the `PNG` file(s).
3. Adjust the "Height (px)" field to `512`, leaving other settings as default.
4. Click "Resize IMAGES".
5. Download the resized icon(s).
- **Remove Empty Space**: Crop any empty space from your SVG files to ensure the icon is properly centered and sized. You can use [SVG Crop](https://svgcrop.com/) to assist with this.
## 🤝 Contributing
### Light and Dark Versions
1. Fork the repository to your GitHub account.
2. Clone the repository to your local machine.
3. Add your icon(s) to the repository, adhering to the specified guidelines.
4. Push your changes to your fork.
5. Create a pull request in the main repository.
- **Monochrome or Single Primary Color Icons**:
- If your icon is monochrome, please provide additional versions if applicable:
- **`-light` Version**: For icons primarily dark or using black as a main color, provide a `-light` version for light backgrounds.
- **`-dark` Version**: For icons primarily light or using white as a main color, provide a `-dark` version for dark backgrounds.
- **Examples**:
- A black logo should include a `-light` version where black is inverted.
- A multicolored logo using black should provide a `-light` version with the black replaced.
- **Tool Recommendation**: [DEEditor](https://deeditor.com/) can help adjust icon colors if needed.
## 🚨 Code of Conduct
### File Naming
Kindly note that contributing to this repository necessitates adherence to our code of conduct, outlined in the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file within the repository.
- **Kebab Case**: Name your files using kebab case (lowercase words separated by hyphens). For example, "Nextcloud Calendar" becomes `nextcloud-calendar.svg`.
- **Note**: Filenames are automatically converted to kebab case, but please double-check your naming to avoid conflicts or errors.
---
### Quality Requirements
Should you have any queries or concerns, feel free to reach out to me using walkxnl@gmail.com. Happy contributing! 🙌
- **No Upscaled Images**: Icons should maintain their original quality without artificial enlargement.
- **No Embedded Raster Images in SVGs**: Ensure that SVG files are true vector graphics without embedded raster images.
## Git Commit Messages
- **Use Gitmoji**: Incorporate [Gitmoji](https://gitmoji.dev/) in your commit messages to keep the commit history clear and expressive. For example:
- `:bento: Adds xxx` when adding new icons.
## Contribution Process
1. **Fork the Repository**: Create a fork of this repository on your GitHub account.
2. **Clone the Repository**: Clone your forked repository to your local machine.
3. **Add Your Icons**: Place your SVG icon(s) into the appropriate directory, following the specifications above.
4. **Commit Your Changes**: Commit your additions with clear and descriptive commit messages using Gitmoji.
5. **Push to Your Fork**: Push your committed changes to your forked repository on GitHub.
6. **Create a Pull Request**: Submit a pull request to the main repository for review.
## Code of Conduct
By contributing, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please review it to understand the expectations for all participants.
## Contact
If you have any questions or need assistance, feel free to reach out at [bjorn@lammers.media](mailto:bjorn@lammers.media). I'm happy to help.