Skip to content
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.

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

Added resources section to CONTRIBUTING.md #975

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
<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>
<li><a href="#resources">Recommended resources and tools</a></li>
</ul>

<hr>
Expand Down Expand Up @@ -490,3 +491,13 @@ We are running a Discord server. You can go here to talk, discuss, and more with
<li>Create a <a href="https://github.com/devicons/devicon/releases/new">new release</a> using the format "<b>Release v<i>MAJOR</i>.<i>MINOR</i>.<i>PATCH</i></b>" as tag and release title. Use the earlier created description as description of the release.</li>
<li>Publishing the release will trigger the <a href="/.github/workflows/npm_publish.yml">npm_publish.yml</a> workflow which will execute a <code>npm publish</code> leading to a updated <a href="https://www.npmjs.com/package/devicon">npm package</a> (v<i>MAJOR</i>.<i>MINOR</i>.<i>PATCH</i>).</li>
</ol>

<h2 id='resources'>Recommended resources and tools</h2>

| Tool Name | Link | Description & Usage |
| :----------------- | :------------------------------------------------- | :------------------------------------------------- |
| Inkscape | https://inkscape.org/ | Desktop application for editing and Making SVG's |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Inkscape | https://inkscape.org/ | Desktop application for editing and Making SVG's |
| Inkscape | https://inkscape.org/ | Desktop application for editing and making SVG's |

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

already merged :S

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Want to make another PR to fix this? :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but I don't think I have time until next year. Feel free to make a PR if you want the change before that :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's alright. I'm updating the docs and converting it into the GitHub wikis anyway. I'll watch out for this.

| Visual Studio Code | https://code.visualstudio.com/ | A code editor for editing code |
| vscode.dev | https://vscode.dev/ | Visual Studio Code in the browser |
| Iloveimg | https://www.iloveimg.com/resize-image/resize-svg | Resizing SVG's |
| svgviewer.dev | https://www.svgviewer.dev/ | View, save, and optimize SVGs |