Skip to content

New Feature: Update the docs for CONTRIBUTING.md #824

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Thomas-Boi merged 2 commits into from
Aug 23, 2021
Merged

New Feature: Update the docs for CONTRIBUTING.md #824

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47f30c2
Update the docs for CONTRIBUTING.md
Thomas-Boi Aug 23, 2021
17cb41e
Merge branch 'develop' into thomas/docs/updateDocs
Panquesito7 Aug 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ First of all, thanks for taking the time to contribute! This project can only gr
<li><a href="#example">Example of Submitting An Icon</a></li>
<li><a href="#updatingIcons">Updating an Icon</a></li>
<li><a href="#teams">Maintainer/Reviewer/Teams</a></li>
<li><a href="#buildScript">Our Workflows: how they work and their issues</a></li>
<li><a href="#buildScript">Our Workflows: how they work</a></li>
<li><a href="#bugs">Common Bugs and Solutions</a></li>
<li><a href="#discordServer">Discord server</a></li>
<li><a href="#release">Release strategy, conventions, preparation and execution</a></li>
</ul>
Expand Down Expand Up @@ -411,6 +412,8 @@ As an example, let's assume you have created the SVGs for Redhat and Amazon Web
<li>Creating a list of features that was added since last release. See <a href="https://github.com/devicons/devicon/discussions/574">this discussion</a> for inception and limitations. </li>
</ul>

<hr>
<h2 id='bugs'>Common Bugs and Solutions</h2>
<p>There are some bugs that the build scripts might run into. Listed below are the common ones and their solutions</p>
<ol>
<li><b>No connection could be made because the target machine actively refused it. (os error 10061)</b>
Expand All @@ -437,7 +440,7 @@ As an example, let's assume you have created the SVGs for Redhat and Amazon Web
<ul>
<li>See <a href="https://github.com/devicons/devicon/pull/532">this PR</a>'s peek result.</li>
<li>This is caused by a bug in Icomoon's parser (see <a href="https://github.com/devicons/devicon/pull/532#issuecomment-827180766">this</a>).</li>
<li>Solution: Luckily this is an extremely rare case. Try remake the SVG in a different way (using different paths/shapes) and test using Icomoon.</li>
<li>Solution: Luckily this is an extremely rare case. Try remaking the SVG in a different way (using different paths/shapes). If your text/paths are joined with another object (say, the logo), try splitting them into individual paths (see <a href="https://github.com/devicons/devicon/pull/816#issuecomment-904021383">this PR</a>). You can always test using Icomoon to see if your fix works.</li>
</ul>
</li>
</ol>
Expand Down