mirror of
https://github.com/SimonPistache/famfamfam-silk-svg.git
synced 2025-09-10 22:26:28 +02:00
feat: Init Contribution and fill Readme
This commit is contained in:
61
CONTRIBUTION.md
Normal file
61
CONTRIBUTION.md
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
# 📒 Contribution guidelines
|
||||||
|
Contributions and discussions are welcomed to this project!
|
||||||
|
|
||||||
|
## Code of conduct
|
||||||
|
|
||||||
|
I believe that healthy debate and disagreement are essential to a healthy project and community. However, it is never ok to be disrespectful. Diverse opinions are welcomed as long as respect is maintained.
|
||||||
|
|
||||||
|
- Be friendly and welcoming.
|
||||||
|
- Be patient.
|
||||||
|
- Be thoughtful.
|
||||||
|
- Be respectful.
|
||||||
|
- Be charitable.
|
||||||
|
- Be constructive.
|
||||||
|
- Be responsible.
|
||||||
|
|
||||||
|
## TOC
|
||||||
|
|
||||||
|
Learn about:
|
||||||
|
1. [Open a topic to discuss](#-discussions)
|
||||||
|
2. [Open an issue about a bug, improvement or to suggest icons](#️-i-would-like-to-report-a-bug-or-an-issue)
|
||||||
|
3. [Open a PR to patch or contribute to the project]()
|
||||||
|
|
||||||
|
## 💬 Discussions
|
||||||
|
|
||||||
|
> Discussion are topics users can speak about, but doesn't relate to a problem or an actionnable task. Discussion must be related to the project.
|
||||||
|
|
||||||
|
To open a topic, go to the discussion tab on this project.
|
||||||
|
|
||||||
|
## 🐞 Issues
|
||||||
|
|
||||||
|
> Issues allow users to report bugs, request improvement or suggest ideas.
|
||||||
|
|
||||||
|
You can open an issue for the following categories. Use the corresponding labels.
|
||||||
|
* **minor bug**: Bug that slightly affect visual or render aspects of an icon, or that is not impeding the project.
|
||||||
|
* **major bug**: Annoyance on the project or icons not following the original style.
|
||||||
|
* **critical bug**: Icon that is visually different from original, or bug blocking the project.
|
||||||
|
* **idea**: Ideas to think on before becoming something else.
|
||||||
|
* **enhance an icon**: Design changes that improve visuals or optimise code.
|
||||||
|
* **design an icon**: Task that consist of designing an Icon or a set of Icon.
|
||||||
|
|
||||||
|
Specific rules applies, and not following them may result in the closing of the issue.
|
||||||
|
* Issue must have a label from one of the available categories
|
||||||
|
* Issue must be sufficiently described, clear and not misleading.
|
||||||
|
* Issue may be flagged as _duplicate_ if the topic is already discussed on another issue. To avoid your issue being closed early, please search for duplicated before opening one and comment or upvote it instead.
|
||||||
|
|
||||||
|
## 🪄 Code contribution
|
||||||
|
|
||||||
|
> Code contribution can take form of new icons in SVG or changes to existing icons in the goal to improve them.
|
||||||
|
|
||||||
|
Pull Requests must follow the rules below:
|
||||||
|
- Contributions must be related to an issue. Please create one before opening a PR.
|
||||||
|
- Code related to icons must follow icons design guidelines
|
||||||
|
|
||||||
|
## Icon design guideline
|
||||||
|
|
||||||
|
- Icons must be in the **style and spirit of the original work** from Marc.
|
||||||
|
- Icons must be in **SVG**.
|
||||||
|
- Icons must be designed to be **legible in any size from 16×16px to 64×64px**. It must have the right balance between too much details and too little.
|
||||||
|
- Icon improvement based on existing icons must be as close as possible to the original design.
|
||||||
|
- Icon must render without visual artefact in today's broswer such as WebKit, Blink, Gecko.
|
||||||
|
|
49
README.md
49
README.md
@@ -1,16 +1,41 @@
|
|||||||
# famfamfam-silk-svg
|

|
||||||
A recreation of the iconic iconset of the 2010’s era from Marc James, remade in SVG and as a figma UI kit for today’s developpers and designers needs.
|
|
||||||
|
# FamFamFam Silk as SVG
|
||||||
|
> The iconic iconset of the 2010’s era from Marc James, remade in SVG and Figma kit for today’s needs.
|
||||||
|
|
||||||
|
|
||||||
|
## 🚀 Getting started
|
||||||
|
|
||||||
|
This work contains icons in SVG ready to use as you need it. Feel free to:
|
||||||
|
|
||||||
|
* Clone or fork the repository.
|
||||||
|
* Use the [Figma UI Kit](https://)!
|
||||||
|
* Or simply download files from the [icons](./icons/) folder.
|
||||||
|
|
||||||
|
### Mix and Match icons to create new ones.
|
||||||
|
|
||||||
|
(this section is for v2)
|
||||||
|
You may not find the perfect match from the 1000 icons here, so here come the [decorators](./decorators/) and [parts](./parts/) folders.
|
||||||
|
|
||||||
|
- Decorators are bullet-like icons that you can place above an existing icon to give it more meaning.
|
||||||
|
`image of a composition`
|
||||||
|
- Some icons have parts available to allow you to customize or change element of an icon to your need.
|
||||||
|
`image of parts and variations arout them (using the user icon as example)`
|
||||||
|
|
||||||
|
## Contribute 🧑🎨
|
||||||
|
|
||||||
|
Contributions are welcomed to this project! Want to contribute?, pick the righ section below:
|
||||||
|
|
||||||
|
**🖐️ I would like to report a bug or an issue!**
|
||||||
|
The issue section is the right place for you to describe your problem. Please take time to review existing issue to avoir duplicates.
|
||||||
|
|
||||||
|
**🩹 I have fixed this icon, how can I give it back?**
|
||||||
|
*Fork* → *Patch* → *Push* → *Pull Request*. Please read the Contribution guideline or your contribution may not be approved.
|
||||||
|
|
||||||
|
**🪄 Can I create an icon too?**
|
||||||
|
Sure! Take note of the Contribution guideline and *Fork* → *Create* → *Push* → *Pull Request*.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
I have not settled on the right licence for this product, so as for now I'll follow Mark James' Create Commons Attribution. He used 2.5, but I picked version 4.
|
I have not settled on the right licence for this product, so as for now I'll follow Mark James' Create Commons Attribution. He used 2.5, but I picked version 4.
|
||||||
I would like a more protective licence, one that could permit company and users to pick stuff here and use them in commercial products and marketing material, but prevent "stealing" stuff or changing ownership over minimal visual changes.
|
I would like a more protective licence, one that could permit company and users to pick stuff here and use them in commercial products and marketing material, but prevent "stealing" stuff or changing ownership over minimal visual changes.
|
||||||
|
|
||||||
## Contribution
|
|
||||||
|
|
||||||
- All enhancement are welcomed
|
|
||||||
- Contributions must be in form of a PR to the main branch
|
|
||||||
|
|
||||||
Contributions can be
|
|
||||||
- fixes or improvements over the existing icons
|
|
||||||
- new icons in the strict aestetics of the original work
|
|
BIN
public/cover.png
Normal file
BIN
public/cover.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 170 KiB |
Reference in New Issue
Block a user