libretro/RetroArch
1
0
Fork 0
mirror of https://github.com/libretro/RetroArch.git synced 2024-11-26 17:50:56 +00:00
Code Issues Actions 44 Packages Projects Releases Wiki Activity

Bring CONTRIBUTING.md in line with current practices (#16841)

Browse Source 
Added a few more places for submitting various issues.
Removed the extra logging instruction for Phoenix (project seems to be abandoned since years).
This commit is contained in:
zoltanvb 2024-08-07 02:03:49 +02:00 committed by GitHub
parent abffbb95d4
commit d90e8c6a79
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
CONTRIBUTING.md
View File

@ -14,25 +14,39 @@ If there are any issues, we are willing to have discussions about it.
## Submitting Bug Reports ## Submitting Bug Reports
Bug reports in _RetroArch_ may fall into one of two categories: Bug reports for _RetroArch_ may fall into a few categories:
* _RetroArch_ itself, the user interface and API around all of the various cores. * _RetroArch_ itself, the user interface and API around all of the various cores.
* Individual _Core_, of which interact with _RetroArch_. * Individual _Core_, that interacts with _RetroArch_.
* Supplementary data provided within _RetroArch_, such as controller autoconfigs, databases,
thumbnails...
* The [documentation set](https://docs.libretro.com/)
When submitting a bug report, ensure that the report is submitted to the correct repository. When submitting a bug report, ensure that the report is submitted to the correct repository.
For _RetroArch_ itself, it is done by reporting a bug within the * For _RetroArch_ itself, submit an issue to the [RetroArch](https://github.com/libretro/RetroArch)
[RetroArch](https://github.com/libretro/RetroArch) repository. For other cores, please use repository. Please read and fill the issue template.
the search function within the [libretro Organization](https://github.com/libretro) on * For other cores, please use the search function within the [libretro Organization](https://github.com/libretro)
GitHub. Issues that are specific to a core and not _RetroArch_ are likely to be closed very on GitHub. Issues that are specific to a core and not _RetroArch_ are likely to be closed
quickly. If an issue is suspected with _RetroArch_, please make sure to test with multiple very quickly. If an issue is suspected with _RetroArch_, please make sure to test with
cores to be sure that is is not isolated. multiple cores to be sure that is is not isolated.
* For database content, submit an issue to
[libretro-database repo](https://github.com/libretro/libretro-database) or ask in the
_database_ channel on Discord.
* For controller autoconfigs, submit an issue to
[retroarch-joypad-autoconfig repo](https://github.com/libretro/retroarch-joypad-autoconfig)
* For actual thumbnail images, submit an issue to
[libretro-thumbnails](https://github.com/libretro-thumbnails/libretro-thumbnails) repo
or ask in the _database_ channel on Discord.
* For documentation, submit an issue to [libretro-docs](https://github.com/libretro/libretro-docs)
repo or ask in the _documentation_ channel.
* For translations, please see [here](https://docs.libretro.com/development/retroarch/new-translations-crowdin/).
If the issue occurs during runtime, please paste the verbose log output: If the issue occurs during runtime, please paste the verbose log output:
* If using the _Pheonix_ interface, the log will be in _File_ -> _Show Log_.
* If using the main interface, enable verbose logging with _Settings_ -> _Logging_ -> * If using the main interface, enable verbose logging with _Settings_ -> _Logging_ ->
_Logging Verbosity_. Ensure both _Log to File_ and _Timestamp log Files_ is enabled. _Logging Verbosity_. Ensure both _Log to File_ and _Timestamp log Files_ is enabled.
* Otherwise, run _RetroArch_ with the verbose (`-v`) flag. Set frontend log level to _0 (Debug)_.
* Or run _RetroArch_ with the verbose (`-v`) flag and get the log from the console.
If the error happens during compilation and/or building, paste the output of `./configure` If the error happens during compilation and/or building, paste the output of `./configure`
and `make` accordingly. If using an IDE, please paste any of the errors and log output. and `make` accordingly. If using an IDE, please paste any of the errors and log output.