atisawd / boxicons

High Quality web friendly icons
https://boxicons.com
MIT License
2.96k stars 296 forks source link

Design Guidelines for Contributing New Icons #35

Open waiyan13 opened 5 years ago

waiyan13 commented 5 years ago

It would be great if there are guidelines for contributors in the documentation.

Examples could be found at Feather Icons or Simple Icons

Any information on dimensions and constraints for current icons would be great.

Also setting guidelines for icon requests would make it easier to submit and clear any ambiguity.

Setting up a project for adding new icons based on those requests will enable faster checking when adding new icons in the future.

atisawd commented 5 years ago

Will work on this soon

binyamin commented 5 years ago

@atisawd How does this look?

calvinomiguel commented 2 years ago

Hey @atisawd I am so thankful for this project. It's one of the best icon packs I've used. Fontawesome is out there, but I like the curves of your icons better. However as already stated it would be cool to have a guideline, so that more people could contribute to push this project forward. Lots of essential and request icons still missing, and option for thinner versions, or duo-tone icons too. Let us know what are the guidelines so we can contribute too.

If there is already one out there, let me know 😄 Thank you for your work!!

calvinomiguel commented 2 years ago

@atisawd How does this look?

@binyamin were you ever able to contribute somehow? I'd like to but not sure if there was ever a guideline released.

binyamin commented 2 years ago

@calvinomiguel honestly, I don't use this project anymore. I go with feather icons, or its community-driven counterpart lucide.

atisawd commented 2 years ago

Hi @binyamin and @calvinomiguel please do tell me what needs to be done , because i am just one person working on this project since the start, except for npm . I have my own work to take care of , this is just a side project but i still want to improve it.

calvinomiguel commented 2 years ago

Hi @binyamin and @calvinomiguel please do tell me what needs to be done , because i am just one person working on this project since the start, except for npm . I have my own work to take care of , this is just a side project but i still want to improve it.

Hi there, well we just want to have guidelines. A small tutorial so that we know how you create the icons. If we habe that we could help with the creations of icons. I could be crrating pull requests then and if you like ghe work, you'd integrate it to the main branch. This way the project can grow faster. But again, we need guidlines for the code part but as well for the design, to make sure the visuals of the icons are consistant to the existing library.

atisawd commented 2 years ago

Hi @calvinomiguel , i follow the material icon guidelines of 24px x 24px artboard and 2 px padding the cap for the strokes used are butt cap the corner for the strokes used are round join the corner radius used for regular icons are 1px for solid icons the corner radius is 2px the spacing between different elements is usually 2px

I will make a comprehensive guide taking other icon sets as an example but for now this should work. You can add the svg in the folders in the repository according to the style.

The naming system for the icons are a prefix of "bx" for regular , "bxs" for solid and "bxl" for logos. Do check that the names aren't repeated.