From ae181274096043983864e4e3134de04982c57462 Mon Sep 17 00:00:00 2001 From: Nick Heindl Date: Tue, 5 Jan 2016 18:08:25 -0600 Subject: [PATCH 1/3] Fixed broken link; Add wiki link; Formatting Added the wiki link and better description. Fix broken link of 'todo'. Formatted 'Coding Style' to 'Code Formatting Guidelines' for consistency. Added the Commenting Etiquette link as well. --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 47a4cac58d..73aeb89415 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,7 @@ [Please read me before posting any issue](https://github.com/PCSX2/pcsx2/wiki/How-to-create-useful-and-valid-issues) -If you want to contribute be sure to check those links - 1. [TODO list](https://github.com/PCSX2/pcsx2/wiki/Idea-of-contribution-%28aka-todo-list%29) +After reading the above, if you still wish to contribute, please check out these links all found on the [wiki](https://github.com/PCSX2/pcsx2/wiki): + 1. [Contributing (TODO List)](https://github.com/PCSX2/pcsx2/wiki/Contributing-(TODO-List)) 2. [wxWidgets coding stategies](https://github.com/PCSX2/pcsx2/wiki/wxWidgets-Coding-Strategies) - 3. [Coding style](https://github.com/PCSX2/pcsx2/wiki/Code-Formatting-Guidelines) + 3. [Code Formatting Guidelines](https://github.com/PCSX2/pcsx2/wiki/Code-Formatting-Guidelines) + 4. [Commenting Etiquette](https://github.com/PCSX2/pcsx2/wiki/Commenting-Etiquette) From 4852d255c79b39eb471fa39bf69285a2477103e0 Mon Sep 17 00:00:00 2001 From: Nick Heindl Date: Wed, 6 Jan 2016 01:08:26 -0600 Subject: [PATCH 2/3] =?UTF-8?q?Format,=20add=20forum=20link,=20and=20organ?= =?UTF-8?q?ize=20per=20PR-889=F0=9F=91=BD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added forum link, organized the wiki links into sections as per suggestions on PR-889 (I found that after I made original PR, apologies). --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 73aeb89415..433118c833 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,27 @@ -[Please read me before posting any issue](https://github.com/PCSX2/pcsx2/wiki/How-to-create-useful-and-valid-issues) +#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 the PCSX2 works. These pages are all found on the github [wiki](https://github.com/PCSX2/pcsx2/wiki). You should probably also check out the [forums](http://forums.pcsx2.net/index.php). -After reading the above, if you still wish to contribute, please check out these links all found on the [wiki](https://github.com/PCSX2/pcsx2/wiki): - 1. [Contributing (TODO List)](https://github.com/PCSX2/pcsx2/wiki/Contributing-(TODO-List)) - 2. [wxWidgets coding stategies](https://github.com/PCSX2/pcsx2/wiki/wxWidgets-Coding-Strategies) - 3. [Code Formatting Guidelines](https://github.com/PCSX2/pcsx2/wiki/Code-Formatting-Guidelines) - 4. [Commenting Etiquette](https://github.com/PCSX2/pcsx2/wiki/Commenting-Etiquette) +* [Just Starting Out](#just-starting-out) +* [Issue Reporting](#issue-reporting) +* [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/Git-survival-guide) +* [How to build PCSX2 for Linux](https://github.com/PCSX2/pcsx2/wiki/Installing-on-Linux) + + +## Issue Reporting +* [How to write a useful issue](https://github.com/PCSX2/pcsx2/wiki/How-to-create-useful-and-valid-issues) + + +## General Documentation And Coding Strategies +* [Commenting Etiquette](https://github.com/PCSX2/pcsx2/wiki/Commenting-Etiquette) +* [Coding style](https://github.com/PCSX2/pcsx2/wiki/Code-Formatting-Guidelines) +* [wxWidgets coding stategies](https://github.com/PCSX2/pcsx2/wiki/wxWidgets-Coding-Strategies) + + +## Tasks +* [Todo List](https://github.com/PCSX2/pcsx2/wiki/Contributing-(TODO-List)) +* [A collection of ideas to improve GSdx OGL](https://github.com/PCSX2/pcsx2/wiki/Todo-List) From b50a777437ba55913f4341ad6fe5d9997773d054 Mon Sep 17 00:00:00 2001 From: Nick Heindl Date: Wed, 6 Jan 2016 01:15:36 -0600 Subject: [PATCH 3/3] Added github issues to the tasks Added github issues to the tasks --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 433118c833..21c5bd7dd7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,4 +24,5 @@ As a first step, please review these links as they'll help you understand how th ## Tasks * [Todo List](https://github.com/PCSX2/pcsx2/wiki/Contributing-(TODO-List)) +* [Issues](https://github.com/PCSX2/pcsx2/issues) * [A collection of ideas to improve GSdx OGL](https://github.com/PCSX2/pcsx2/wiki/Todo-List)