famfamfam-silk-svg/CONTRIBUTION.md

📒 Contribution guidelines

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.

Not following the contributions guidelines may result in issues or PR closing or deletion, the ban of the user's account or reporting to Github staff.

TOC

Learn about:

1. Open a topic to discuss
2. Open an issue about a bug, improvement or to suggest icons
3. Open a PR to patch or contribute to the project
4. Icon design guidelines

💬 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 contributions

Code contribution can take form of new icons in SVG or changes to existing icons in the goal to improve them. The workflow is the classic Github Fork → Commit → Push → Pull Request.

Pull Requests should bind to the Github's best practices. They must follow the rules below:

• It must be related to an issue. Please create one before opening a PR.
• It must have the Conventional Commit principles in commit and PR names. I.e.: fix(#33): Remove duplicate stroke on the main circle
• Changes related to icons must follow icons design guidelines

🎨 Icon design guidelines

• Icons must be in the style and spirit of the original work from Marc James.
• 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, especially at 16×16px.
• Icon must render without visual artefact in today's broswer such as WebKit, Blink, Gecko.