moonlight-embedded/.github/CONTRIBUTING.md
2021-07-22 21:10:24 +02:00

2.4 KiB

Contribution Guide

Got a Question or Problem?

Please take a look at the wiki for answers to your questions about using Moonlight Embedded.

If you still have questions about Moonlight Embedded, please use one of the different forums discussing Moonlight Embedded.

XDA Moonlight in General
Raspberry Pi Forum Moonlight Embedded for Raspberry Pi
SolidRun Community Moonlight Embedded for Cubox-i and Hummingboard
ODROID Forum Moonlight Embedded on ODROID

Found an Issue?

Found a bug in Moonlight Embedded? Please submit an issue. Ensure the following has been checked or we will mark the issue as invalid:

  • The bug is in Moonlight Embedded. If the bug is in NVidia Geforce Experience or Steam the bug can not be fixed.
  • Your system is set up correctly and there are no issues like a firewall misconfiguration.
  • Verify there is no other bug report containing the same issue. Also, check closed issues in case your bug is already solved.

Provide as much information as possible about your setup and how to produce the issue so the chances are higher we can fix it. It's even better if you submit a Pull Request with a fix.

Feature request

There are not many developers working on Moonlight Embedded, and as such it currently doesn't make much sense to use the issue tracker to submit feature requests. Please try to implement feature requests yourself and submit a pull request, or discuss it on one of the forums to see if someone else can implement it.

Submitting a Pull Request

Have you created a cool new feature or fixed a few bugs? You can submit a pull request, but before your request is merged check the following.

  • Your branch is based on a recent commit and can be merged cleanly.
  • Your code uses the same code style as the rest of the code.
  • Your history is cleaned up and you provide one or multiple commits.
  • Your commits only change the necessery lines, and do not accidently changes whitespace or add/remove empty lines.

If these guide lines are not met your pull request may not be mergeg or your pull request will reuire some cleanup before being merged. This depends on how necessary your code is.