muskit/spice2x.github.io
0
0
Fork 0
mirror of https://github.com/spice2x/spice2x.github.io.git synced 2026-08-01 22:30:42 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
bicarus-dev
2025-12-22 18:51:15 -08:00
committed by GitHub
parent 081def30db
commit 462a07680b
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+6
View File
@@ -41,6 +41,11 @@ spice2x has a global audience; majority of the user base do not speak English as
Use simple English, avoid colloquialism, and use concise language, even if it's slightly technical. Use simple English, avoid colloquialism, and use concise language, even if it's slightly technical.
e.g.,
* Instead of `processor`, use `CPU`
* Instead of `KFC`, use `SDVX`
### Using OS APIs ### Using OS APIs
Avoid making permanent changes to user's OS configuration. For example, spice must not make a call to set power profile to Maximum Performance, or switch default audio device. Making the reverse call to restore settings on game shutdown is **not** good enough; there is no guarantee that spice will gracefully shutdown, since games (or spice) can crash. This is to avoid inadvertently putting user's PC into a bad state, which can be seen as malware-like behavior. Avoid making permanent changes to user's OS configuration. For example, spice must not make a call to set power profile to Maximum Performance, or switch default audio device. Making the reverse call to restore settings on game shutdown is **not** good enough; there is no guarantee that spice will gracefully shutdown, since games (or spice) can crash. This is to avoid inadvertently putting user's PC into a bad state, which can be seen as malware-like behavior.
@@ -50,6 +55,7 @@ Watch out for legacy OS compatibility. Currently, the minimum support floor is W
### Code style requirements ### Code style requirements
* Indents are four spaces. * Indents are four spaces.
* Try to keep under 100 characters per line. This includes comments and string literals. * Try to keep under 100 characters per line. This includes comments and string literals.
* Avoid making unnecessary formatting or whitespace changes in a PR; e.g., watch out for text editor automatically stripping trailing whitespace. It pollutes the diff and slows down code review.
* Always use \{ curly braces \} when appropriate; do not omit them even when it's optional; such as `for` `if` `else`, etc. * Always use \{ curly braces \} when appropriate; do not omit them even when it's optional; such as `for` `if` `else`, etc.
OK: OK: