Update contributing guidelines to recommend either SVG or WEBP formats for images

[elsevers]

Closes #8.

Notes

Take a look at my notes in #8 on the amazing file size reduction offered by WEBP files over PNG/JPG.

Self-Review

1. Are all files under 300 kB (if not, please carefully assess whether it is worth committing them)? Yes
2. Are all files named according to the appropriate naming convention, i.e., dash-case, camelCase, snake case? Yes
3. Do all Markdown files follow the CONTRIBUTING article template? Yes
4. Do all links work in the material that the PR is adding? Yes
5. Is the PR configured to close the correct issue(s)? Yes
6. Did the PR fully address the Approach section of the issue(s) it is closing? Yes

Reviewer Instructions

Reviewers, please copy and paste a suitable review checklist into your review and answer all questions.

Appendix

This section should be the same for all PRs. Do not edit this section when creating a PR.

Review Checklists

Checklists maintained by the eLev lab for research repositories include:

• Report checklist
• Publication archive checklist (select a checklist from the Approach that corresponds to the step this PR seeks to complete).
• Standard checklist (if none of the above apply).

Standard checklist

1. Are all files under 300 kB (if not, please carefully assess whether it is worth committing them)? **Yes or No**
2. Are all files named according to the appropriate [naming convention](https://github.com/Severson-Group/research-repo-template?tab=readme-ov-file#file-naming), i.e., dash-case, camelCase, snake case? **Yes or No**
3. Do all Markdown files follow the [CONTRIBUTING article template](https://github.com/Severson-Group/.github/blob/main/CONTRIBUTING.md#markdown-documentation-template)? **Yes or No**
4. Do all links work in the material that the PR is adding? **Yes or No**
5. Is the PR configured to close the correct issue(s)? **Yes or No**
6. Did the PR fully address the `Approach` section of the issue(s) it is closing? **Yes or No**

Please work on addressing any **No** items.

[elsevers]

@AwesomeTornado, can we get your eyes on this and #8?

I am worried that our knowledgebase repo size is getting out of hand, and this webp image format seems like a solution. Have you used webp before? Does windows provide an easy way to view webp images? It is natively supported in MacOS (i.e., via Preview, in Finder, etc.)

[AwesomeTornado]

Yes I have used webp before, windows has good support for it. It would be a good idea to use webp here.

[AwesomeTornado]

@elsevers Do we want to mention light/dark mode support for svg's here? Or is that an issue for another day?

[elsevers]

Thanks!

So, on dark vs light SVGs, I think this is only an issue for Sphinx documentation (i.e. docs.amdc.dev and emach.readthedocs.io), and not for our internal markdown docs, like the knowledgebase and repos, right?

[AwesomeTornado]

I see, yes that's correct.

[AwesomeTornado]

@elsevers looks good!

• Are all files under 300 kB (if not, please carefully assess whether it is worth committing them)? Yes
• Are all files named according to the appropriate naming convention, i.e., dash-case, camelCase, snake case? Yes
• Do all Markdown files follow the CONTRIBUTING article template? Yes
• Do all links work in the material that the PR is adding? Yes
• Is the PR configured to close the correct issue(s)? Yes
• Did the PR fully address the Approach section of the issue(s) it is closing? Yes

[noguchi-takahiro]

@elsevers @AwesomeTornado I think it would be nice if there is an instruction of how to covert any images to .webp? I tried to do this using Power point, Windows Paint, and Photo but there is not options to export as webp.

[noguchi-takahiro]

@AwesomeTornado do you have any recommended tool to convert png or jpg to webp using Windows? I could open .webp using Windows Photo app but there is no option to export:

[elsevers]

Thanks @noguchi-takahiro and @AwesomeTornado, I agree that we need to provide instructions on how to create the images. I have just asked you to review https://github.com/Severson-Group/KnowledgeBase/pull/356, which seeks to add a new KB article on this.

Once we have merged https://github.com/Severson-Group/KnowledgeBase/pull/356, I will revise this present PR to use it.

[elsevers]

@AwesomeTornado and @noguchi-takahiro, I have just updated this to now link to our new webp article. Can you give this PR another review?

[noguchi-takahiro]

Thank you @elsevers. Looks good.

1. Are all files under 300 kB (if not, please carefully assess whether it is worth committing them)? Yes
2. Are all files named according to the appropriate naming convention, i.e., dash-case, camelCase, snake case? Yes
3. Do all Markdown files follow the CONTRIBUTING article template? Yes
4. Do all links work in the material that the PR is adding? Yes
5. Is the PR configured to close the correct issue(s)? Yes
6. Did the PR fully address the Approach section of the issue(s) it is closing? Yes

@AwesomeTornado could you review this PR?