🎉 Thanks for taking the time to contribute! 🎉
If you're having trouble using ps4-waker or otherwise have a question
and are about to file an issue asking for help, make sure you:
- Read through and follow ALL troubleshooting entries in the wiki. A lot of common points of confusion have been explained there, so make use of it!
- Take the time to look through existing, resolved issues in case someone else had a similar issue that didn't get added to the wiki.
- Include enough information to reproduce your problem. That includes exact steps taken, copies of output from commands run (with any sensitive information removed) etc.
- Make sure you test against the latest version of the project to see if the problem has already been fixed.
Please do not email me directly, unless you have a very good reason. I don't have time to provide personal support for free, so if you absolutely cannot find help elsewhere please at least ask for help on a public forum, like the issue tracker here, so others in the future can potentially benefit from your question.
So you want to contribute some code—awesome! When doing so, please try to:
- Follow the same coding style as used in the project. We have an automated linter that will look for the big things, but it may not catch all the aesthetic bits. Do your best!
- Update or add a unit test to verify your change. If you cannot reasonably do this, or feel its unnecessary, please explain why.
- Write good commit messages, explain what your change does, and why.
- Keep pull requests simple: change one thing at a time, unless absolutely necessary; if it is necessary to do more than one thing at once, explain why, and consider opening an issue to discuss your intended changes before starting work on them.