mirror of
https://github.com/walkxcode/dashboard-icons.git
synced 2024-09-01 13:40:23 +02:00
2.7 KiB
2.7 KiB
🤝 Contribution Guidelines
We appreciate your interest in contributing to our icon repository! To ensure smooth collaboration, kindly adhere to the following guidelines:
🌟 Icon Specifications
- Icons should be provided in both
PNG
andSVG
formats. Other formats likeJPEG
orWEBP
will not be accepted.- In cases where an
SVG
version is unavailable, aPNG
version alone suffices. - Conversely, if a
PNG
version is missing, it can be generated using Ezgif SVG to PNG.
- In cases where an
PNG
s should maintain a height of exactly512px
, 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.
- Icons should be named using the Kebab Case 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 to adjust its color.
💻 Gitmoji Commits
- Use Gitmoji 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.
🔀 Converting SVG to PNG
- Go to https://ezgif.com/svg-to-png.
- Upload the
SVG
file by clicking "Upload". - Set the "Height (optional)" field to
512
, leaving other settings as default. - Click "Convert to PNG!".
- Click "Save" located at the bottom right under the converted image.
⤵️ Downscaling PNGs
- Go to https://www.iloveimg.com/resize-image.
- Upload the
PNG
file(s). - Adjust the "Height (px)" field to
512
, leaving other settings as default. - Click "Resize IMAGES".
- Download the resized icon(s).
🤝 Contributing
- Fork the repository to your GitHub account.
- Clone the repository to your local machine.
- Add your icon(s) to the repository, adhering to the specified guidelines.
- Push your changes to your fork.
- Create a pull request in the main repository.
🚨 Code of Conduct
Kindly note that contributing to this repository necessitates adherence to our code of conduct, outlined in the CODE_OF_CONDUCT.md file within the repository.
Should you have any queries or concerns, feel free to reach out to me using walkxnl@gmail.com. Happy contributing! 🙌