diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index 5ab40b989d..0000000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,54 +0,0 @@ -# So you want to contribute to PCSX2? Great - -As a first step, please review these links as they'll help you understand how the development of PCSX2 works. - -* [Just Starting Out](#just-starting-out) -* [Issue Reporting](#issue-reporting) -* [Pull Request Guidelines](#pull-request-guidelines) -* [General Documentation And Coding Strategies](#general-documentation-and-coding-strategies) -* [Tasks](#tasks) - -## Just Starting Out - -* If you're unfamilar with git, check out this [brief introduction to Git](https://github.com/PCSX2/pcsx2/wiki/07-Git-survival-guide) -* [How to build PCSX2 for Windows](https://github.com/PCSX2/pcsx2/wiki/12-Building-on-Windows) -* [How to build PCSX2 for Linux](https://github.com/PCSX2/pcsx2/wiki/10-Building-on-Linux) - -## Issue Reporting - -* [How to write a useful issue](https://github.com/PCSX2/pcsx2/wiki/How-to-create-useful-and-valid-issues) - -## Pull Request Guidelines - -The following is a list of *general* style recommendations that will make reviewing and merging easier: - -* Commit Messages - * Please try to prefix your commit message, indicating what area of the project was modified. - * For example `gs: message...`. - * Looking at the project's commit history will help with keeping prefixes consistent overtime, *there is no strictly enforced list*. - - * Try to keep messages brief and informative - - * Remove unnecessary commits and squash commits together when appropriate. - * If you are not familiar with rebasing with git, check out the following resources: - * CLI - https://thoughtbot.com/blog/git-interactive-rebase-squash-amend-rewriting-history - * GUI (SourceTree) - https://www.atlassian.com/blog/sourcetree/interactive-rebase-sourcetree - -* Code Styling and Formatting - * [Consult the style guide](https://github.com/tadanokojin/pcsx2/blob/coding-guide/pcsx2/Docs/Coding_Guidelines.md) - - * Run `clang-format` using the configuration file in the root of the repository - * Visual Studio Setup - https://devblogs.microsoft.com/cppblog/clangformat-support-in-visual-studio-2017-15-7-preview-1/ - * IMPORTANT - if you are running `clang-format` on unrelated changes (ie. formatting an entire file), please do so in a separate commit. - * If you cannot scope your `clang-format` to just your changes and do not want to format unrelated code. Try your best to stick with the existing formatting already established in the file in question. - -## General Documentation And Coding Strategies - -* [Commenting Etiquette](https://github.com/PCSX2/pcsx2/wiki/06-Commenting-Etiquette) - -* [Coding style](https://github.com/PCSX2/pcsx2/wiki/Code-Formatting-Guidelines) - * [More comprehensive style-guide (Currently in Draft)](https://github.com/tadanokojin/pcsx2/blob/coding-guide/pcsx2/Docs/Coding_Guidelines.md) - -## Tasks - -* [Issues](https://github.com/PCSX2/pcsx2/issues) diff --git a/.github/ISSUE_TEMPLATE/emu_bug_report.yaml b/.github/ISSUE_TEMPLATE/emu_bug_report.yaml index 67a1324575..6e3032d1fa 100644 --- a/.github/ISSUE_TEMPLATE/emu_bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/emu_bug_report.yaml @@ -66,6 +66,10 @@ body: Performance issues as a result of not meeting our hardware requirements are not valid. + Please read our troubleshooting pages and our issue reporting guide. + - [Troubleshooting page](https://pcsx2.net/docs/category/troubleshooting). + - [Issue reporting guide](https://pcsx2.net/docs/troubleshooting/identify). + We are **not** accepting issues related to the **libretro** core. The libretro core is being maintained separately at this time - type: input id: rev diff --git a/.github/workflows/scripts/releases/announce-release/index.js b/.github/workflows/scripts/releases/announce-release/index.js index dad1387c4f..9678980175 100644 --- a/.github/workflows/scripts/releases/announce-release/index.js +++ b/.github/workflows/scripts/releases/announce-release/index.js @@ -66,7 +66,7 @@ const embed = new MessageEmbed() .setDescription("To download the latest or previous builds, [visit the official downloads page](https://pcsx2.net/downloads/).") .addFields( { name: 'Version', value: releaseInfo.tag_name, inline: true }, - { name: 'Installation Steps', value: '[See Here](https://github.com/PCSX2/pcsx2/wiki/Nightly-Build-Usage-Guide)', inline: true }, + { name: 'Installation Steps', value: '[See Here](https://pcsx2.net/docs/category/setup)', inline: true }, { name: 'Included Changes', value: releaseInfo.body, inline: false } ); console.log(embed); diff --git a/README.md b/README.md index 072ff30211..d59c02f68c 100644 --- a/README.md +++ b/README.md @@ -24,4 +24,4 @@ Please note that a BIOS dump from a legitimately-owned PS2 console is required t PCSX2 supports translation into other languages using [Crowdin](https://crowdin.com/project/pcsx2-emulator). -See the [Contributing Guidelines](https://github.com/PCSX2/pcsx2/blob/master/.github/CONTRIBUTING.md) or visit the [GitHub Wiki](https://github.com/PCSX2/pcsx2/wiki) for more info on how to contribute. +See the [Contribution Guide](https://pcsx2.net/docs/contributing/) for more info on how to contribute. diff --git a/pcsx2/Docs/PCSX2_FAQ.md b/pcsx2/Docs/PCSX2_FAQ.md index e86846f425..6c409c0e37 100644 --- a/pcsx2/Docs/PCSX2_FAQ.md +++ b/pcsx2/Docs/PCSX2_FAQ.md @@ -20,7 +20,11 @@ There are a number of ways to help the project, whether it be bug reporting, gam * Want to make changes to emulator code? [Check out the issue tracker](https://github.com/PCSX2/pcsx2/issues), or [fork the PCSX2 repository and work on your own ideas](https://github.com/PCSX2/pcsx2). * Want to patch games? [Check out the cheats and patches forum thread for inspiration](https://forums.pcsx2.net/Thread-Post-your-PCSX2-cheats-patches-here). There are other threads to find as well, [such as those dedicated to 60 FPS patches](https://forums.pcsx2.net/Thread-60-fps-codes) or [widescreen patches](https://forums.pcsx2.net/Thread-PCSX2-Widescreen-Game-Patches). +<<<<<<< HEAD * Want to report bugs you have discovered in your games? Head over to [the Bug Reporting section of the PCSX2 forums](https://forums.pcsx2.net/Forum-Bug-reporting), to [the PCSX2 Discord](https://pcsx2.net/discord), or to [the GitHub issues section](https://github.com/PCSX2/pcsx2/issues). +======= +* Want to report bugs you have discovered in your games? [Head over to the Bug Reporting section of the PCSX2 forums](https://forums.pcsx2.net/Forum-Bug-reporting). Also check out our [Issue reporting guide](https://pcsx2.net/docs/troubleshooting/identify) for info on how to better report to us issues. +>>>>>>> 091a4ee5a (docs: update in order to redirect from the GH wiki to our website) * Want to update us on the compatibility of your games? [Take a look at the Public Compatibility List on the PCSX2 forums](https://forums.pcsx2.net/Forum-Public-compatibility-list) * Want to improve the PCSX2 wiki? [Here is how to contribute](https://wiki.pcsx2.net/How_to_contribute) @@ -120,9 +124,7 @@ If you are using a disc: Fast Boot, enabled by default, will directly mount and launch the game without first launching the PS2 BIOS. You may disable this in Settings > BIOS > Fast Boot if you wish to see the BIOS startup animation or if Fast Boot is causing an issue. ### Question 18: How do I build the PCSX2 source code? -* [Windows build guide](https://github.com/PCSX2/pcsx2/wiki/12-Building-on-Windows) -* [Linux build guide](https://github.com/PCSX2/pcsx2/wiki/10-Building-on-Linux) -* [macOS build guide](https://github.com/PCSX2/pcsx2/wiki/11-Building-on-MacOS) +Have a nice [building guide](https://pcsx2.net/docs/advanced/building) :) . ### Question 19: When will the next version be released? It will be released when it is ready. Please don't waste your time and ours asking when.