PCSX2 Documentation/Commenting Etiquette: Difference between revisions
Jump to navigation
Jump to search
PCSX2 Documentation/Commenting Etiquette (view source)
Revision as of 17:12, 19 July 2015
, 19 July 2015no edit summary
No edit summary |
No edit summary |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
==... or "How to post comments without making everyone else not like you."== | |||
GitHub allows users to comment nearly everywhere. You can comment on issues, on commits, or even on one concrete line of a commit. This is a very powerful tool, but also has a great potential for abuse. | GitHub allows users to comment nearly everywhere. You can comment on issues, on commits, or even on one concrete line of a commit. This is a very powerful tool, but also has a great potential for abuse. | ||
| Line 9: | Line 9: | ||
There are a few rules an guidelines that we all need to follow in order for this public feedback system to work: | There are a few rules an guidelines that we all need to follow in order for this public feedback system to work: | ||
* Comments should be relevant to the commit/issue and should contain | * Comments should be relevant to the commit/issue and should contain '''useful information'''. | ||
* If you're having general problems with PCSX2, you can use our [Issue | * If you're having general problems with PCSX2, you can use our [https://github.com/PCSX2/pcsx2/issues Issue Tracker], or if you don't really know what revision causes it, our [http://forums.pcsx2.net/ Public Forum]. This way we can discuss and troubleshoot the issue in depth, in its right place. | ||
* Statements like "Please make it faster" or "please fix my game" are not acceptable and will be deleted. | * Statements like "Please make it faster" or "please fix my game" are not acceptable and will be deleted. | ||
* Phrasing the statement as a question like "Will this make it faster?" or "Will this fix my game?" is not acceptable either, and will also be deleted. | * Phrasing the statement as a question like "Will this make it faster?" or "Will this fix my game?" is not acceptable either, and will also be deleted. | ||
* If we delete your post, there was a good reason for it. Deleting posts without justification would be counter-productive, much the same way that allowing posts with no relevant content would also be counter-productive. | * If we delete your post, there was a good reason for it. Deleting posts without justification would be counter-productive, much the same way that allowing posts with no relevant content would also be counter-productive. | ||
* If you find yourself thinking that the PCSX2 Team is some group of irrational dictators who delete posts simply because we don't like your opinion, then you | * If you find yourself thinking that the PCSX2 Team is some group of irrational dictators who delete posts simply because we don't like your opinion, then you '''probably shouldn't be posting.''' | ||
{{PCSX2 Documentation Navbox}} | |||