From fa782046f9dae597410cc167f1a25e03a96f2421 Mon Sep 17 00:00:00 2001 From: Ani Date: Sun, 16 Apr 2017 21:32:58 +0100 Subject: [PATCH] Add CONTRIBUTING.md guidelines (#2706) Due to the big amount of invalid issues being submitted later, I think we need to activate those. --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..48d76bda18 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Getting Started + +Before getting started using the emulator, read the [Quickstart Guide](https://rpcs3.net/quickstart) and the [FAQ](https://rpcs3.net/FAQ). After reading those, if you need support, visit our [Forums](http://www.emunewz.net/forum/forumdisplay.php?fid=172). + +# Issue Reporting + +**The GitHub Issue Tracker is not the place to ask for support or to submit [Game Compatibility](https://rpcs3.net/compatibility) reports.** Requests for support or incorrect reports will be closed. If you are not sure whether the issue you want to report is an actual issue that is not yet known, please use the forums to submit such report. + +**Before reporting an issue:** +- Check if your system matches all the minimum requirements listed in the [Quickstart Guide](https://rpcs3.net/quickstart); +- Check if the issue is meaningful for the team (e.g. The Last of Us doesn't work is obvious and therefore useless); +- Search older issues/forum threads to see if your issue was already submitted. +- Use understandable English. It doesn't need to be perfect, but clear enough to understand your message. +- While reporting issues, don't forget to include details about your system (OS, CPU, GPU, etc.), as well as the RPCS3.log file. + +Submitting your test results for Commercial Games must be done on our forums' [Commercial Games](http://www.emunewz.net/forum/forumdisplay.php?fid=193) section. If there's already a thread for the game you want to report post in it, otherwise please make a new thread following the [Guidelines for submitting new games](http://www.emunewz.net/forum/showthread.php?tid=174376). + +# Contributing + +Check the [Coding Style Guidelines](https://github.com/RPCS3/rpcs3/wiki/Coding-Style), [Roadmap](https://github.com/RPCS3/rpcs3/wiki/Roadmap) and [Developer Information](https://github.com/RPCS3/rpcs3/wiki/Developer-Information). If you have any questions, hit us up on our [Discord Server](https://discord.me/RPCS3) in the **#development** channel.