# Contributing Guidelines

_Pull Requests, issues, and other contributions are appreciated and encouraged!_ ❤️

### Contents

- [Docs Website](#docs-website)
- [Issues](#issues)

## Docs Website

The website's content aims to be clean and technical. It aids the community with their PON-related needs and
helps potential sponsors understand what we are all about!

To contribute to existing guides and/or create new ones, the markdown files can be found within the
[posts directory](./docs/posts).

Full page screenshots aid users with navigation and are the desired. To take a screenshot, follow the guides for
your browser of choice:

* FireFox:
  https://support.mozilla.org/en-US/kb/take-screenshots-firefox
* Edge:
  https://www.microsoft.com/en-us/edge/learning-center/screenshot-webpage
* Chrome:
  https://zapier.com/blog/full-page-screenshots-in-chrome/
* Safari:
  https://www.idownloadblog.com/2021/04/08/capture-full-page-screenshots-safari-firefox-chrome-mac/

Furthermore, to save bandwidth and increase load times, screenshots should be converted to the webp format with
[cwebp](https://developers.google.com/speed/webp/docs/cwebp) using 60% resolution e.g.
`cwebp -q 60 screenshot.jpg/png -o screenshot.webp`.

All artwork is created using free software, including but not limited to [Inkscape](https://inkscape.org/),
[GIMP](https://www.gimp.org/), and [KRITA](https://krita.org/). When complete, it is exported at a 1280x960p
resolution and converted into the webp raster graphics file format with the same utility and options as the
screenshots mentioned above.

## Issues

Issues can be reported here on github or our [community discord server](https://discord.pon.wiki). Pull requests are
especially welcome.