mirror of
https://github.com/spice2x/spice2x.github.io.git
synced 2026-08-02 06:40:42 -07:00
Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| a7e7eb36be | |||
| 962db5d4d4 | |||
| b59db8dd14 | |||
| 680e7a7bda | |||
| 5e67ce5067 | |||
| 4051c728fc | |||
| ae4dbece0a |
@@ -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)
|
||||
>
|
||||
|
||||
@@ -9,6 +9,14 @@ 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.
|
||||
|
||||
### Code quality requirements
|
||||
|
||||
* Test for regressions, at least in and around the component you are modifying:
|
||||
|
||||
@@ -20,13 +20,21 @@ spice2x team does not provide any tools to circumvent software copy protection,
|
||||
|
||||
[List of supported games](https://github.com/spice2x/spice2x.github.io/wiki/List-of-supported-games)
|
||||
|
||||
## How do I set up game data & start playing?
|
||||
|
||||
By policy,
|
||||
|
||||
* we do **NOT** provide links on where to acquire game data
|
||||
* we do **NOT** provide guides on setting up & basic troubleshooting
|
||||
|
||||
please do not ask for these, as it will never happen here.
|
||||
|
||||
## Submitting to the Issue Tracker
|
||||
Rules for filing a new issue or adding comments to existing issues in the tracker:
|
||||
|
||||
* 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 on how to run these games. Please ask where you obtained the game data.
|
||||
* This is not the place to ask about other projects, especially EA servers. Bad servers can (and will) crash your game.
|
||||
* This is not the place to obtain a guide or receive basic troubleshooting.
|
||||
* **Do not link to external websites that distribute game data!**
|
||||
* **Do not link to external websites that provide guides on how to run games!**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user