Update CONTRIBUTING.md

.github/ISSUE_TEMPLATE/patch-submission.md

@@ -10,6 +10,7 @@ assignees: ''
 > [!NOTE]
 > Before submitting code changes... 
 > * Please do note that this is a GPL v3.0 open source project.
+> * Please read the [CONTRIBUTING](https://github.com/spice2x/spice2x.github.io/blob/main/CONTRIBUTING.md) guide.
 > * Maintainers reserve the right to reject or modify your submission without reason.
 > * If accepted, your github user name will be credited on the main web page, and then archived in the [past versions wiki page](https://github.com/spice2x/spice2x.github.io/wiki/Past-versions-and-change-log)
 > 

CONTRIBUTING.md

@@ -9,6 +9,16 @@ Baseline rules for patch submissions are as follows. Any patches violating the r
 * For a new game that was never supported (not a new version of a game, but rather a new series): please wait 1 year after official AC release in Japan.
 * For new version of an already supported game: proceed with caution and use generally-accepted community guidelines.
 
+### Avoiding regressions
+
+The biggest risk in making code changes to spice is the risk of regressions. There is a **lot** of shared code used by many different games, reaching back game versions that are more than a decade old. It is practically impossible to test all supported games and versions.
+
+Additionally, there's a lot of code that get exercised on specific hardware - including hardware that you probably don't have access to (e.g., ICCA reader, real cabinet I/O, specific model of a IIDX controller, particular brand of touch screens...)
+
+Therefore, when making code changes, please be extremely careful about containing / scoping your changes. Make targeted bug fixes scoped to handful of game versions and hardware configuration. When adding new features, make it off by default, unless there is a really good reason to make it the default. If you make a new default, add an option that disables it so that users can opt out as needed.
+
+Lastly, watch out for legacy OS compatibility. Currently, the minimum support floor is Windows 7. If you use any Windows API, make sure it's supported in Windows 7. If you need to use API that is not present in Windows 7, you must not directly link against it, otherwise spice will fail to launch on older OSes. Take a look at Windows 8 touch code (win8.cpp) for examples on how to discover OS APIs via pointers.
+
 ### Code quality requirements
 
 * Test for regressions, at least in and around the component you are modifying:
@@ -21,3 +31,4 @@ Baseline rules for patch submissions are as follows. Any patches violating the r
 * Do not make code changes in unrelated areas; i.e., do not run code linters and auto-formatters for parts of the code that you didn't modify.
   * Note: there are no strict rules for code formatting, but please attempt to emulate the style around the code you are modifying.
 * Try to submit smaller chunks of code, instead one gigantic patch. For example, don't submit a patch for "Improve feature XYZ"; instead, submit "Change how A works to prepare for feature XYZ" "Refactor B for feature XYZ" "Add feature B to enable feature XYZ".
+* Write to the log for anything useful - it helps immensely with debugging post-mortem. At the same time though, avoid spamming the log for something trivial.

README.md

@@ -35,7 +35,9 @@ Rules for filing a new issue or adding comments to existing issues in the tracke
 * Check the [known issues](https://github.com/spice2x/spice2x.github.io/wiki/Known-issues) page first before reporting a new issue.
 * Use the search function and see if there is an existing issue. 
 * This is not the place to obtain a guide or receive basic troubleshooting.
-* **Do not link to external websites that distribute game data!**
+* Don't file a bug demanding game XYZ to be supported.
+* **Do not upload game data - any part of it, XML files included!**
+* **Do not mention or link to external websites that distribute game data!**
 * **Do not link to external websites that provide guides on how to run games!**
 
 New GitHub accounts are prevented from creating new issues to prevent spam. Maintainers of this project reserve the right to close or delete any issues that violate the rules above, or low effort issues.