CONTRIBUTING.md

How to Contribute to Playnite Web

• Report a Bug
• Contribute a Bug Fix
• Request or Add Feature
• Contribute to the Documentation
• Learn More About the Source Code
• Thank You

Report a Bug

Note: If you discover a security vulnerability, do not open an issue. To report a security bug, submit a security advisory on GitHub.

Report bugs when Playnite Web behaves unexpectedly or a problem prevents you from using it.

1. Make sure you're reporting a new bug by searching any currently open issues on GitHub.
2. Open a new issue.
3. In your issue, include:
   • A descriptive title that begins with bug:
   • A description of the bug, what you where doing, and what occured.
   • Screenshots that show the problem, if possible.

Contribute a Bug Fix

1. Read the Playnite Web Conventions guide to learn more about coding conventions and general guidelines.
2. Open a new GitHub pull request with your bug fix.
3. In your pull request, include:
   • A descriptive title that begins with fix:
   • A description of the problem and how it affects users.
   • An explanation of how you solved the problem.
   • The issue number your pull request fixes, if applicable.

Request or Add a Feature

Note: We may only accept changes that contribute to the stability, functionality, or testability of Playnite Web.

Request a new feature when you think Playnite Web is missing a capability or experience that would benefit users.

1. Don't open a Github issue.
2. Post in the #feature-request channel on the Discord.
3. In your request, explain the goal of the new feature and how it benefits users. Describe the problem that needs to be solved.
4. Wait to receive community feedback.
5. If you developed the feature and want to add it to the main repository, open a pull request and include:
   • A descriptive title that begins with feat:
   • A description of what you changed.
   • An explanation of how your change benefits users.
   • The issue number your pull request fixes, if applicable.

Contribute to the Documentation

1. Read the documentation style guide.
2. Open a new GitHub pull request with your doc updates.
3. In your pull request include:
   • A descriptive title with that begins with docs:
   • A description of what you changed.
   • An explanation of how your change improves the documentation.
   • The issue number your pull request fixes, if applicable.

Learn More About the Source Code

You can ask questions and learn more about Playnite Web by joining our Discord server.

Thank You

Playnite Web is a volunteer effort and we encourage you to pitch in and join us!

You can find us on Discord!

Thanks! ❤️ ❤️ ❤️