Compare commits

...

16 Commits

Author SHA1 Message Date
sp2xdev 550dd08f19 Update README.md 2024-05-17 01:33:59 -07:00
sp2xdev eafe7a834a Create CONTRIBUTING.md 2024-05-17 01:32:54 -07:00
sp2xdev 6e8c87921b Update issue templates 2024-04-30 03:00:03 -07:00
sp2xdev ccf4ac2080 Update README.md 2024-04-25 18:01:39 -07:00
sp2xdev 98188524d7 Update README.md 2024-04-25 18:00:30 -07:00
sp2xdev 7477a9996d Update README.md 2024-04-25 17:28:34 -07:00
sp2xdev ab2625ec73 Update README.md 2024-04-25 17:27:51 -07:00
sp2xdev df5da69be6 Update README.md 2024-04-25 17:27:16 -07:00
sp2xdev 5618ae9694 Update README.md 2024-04-25 17:26:16 -07:00
sp2xdev 8a4236fba5 Update README.md 2024-04-25 17:25:48 -07:00
sp2xdev d5104ac117 Update README.md 2024-03-24 21:42:37 -07:00
sp2xdev 8c8e2de4f6 Update issue templates 2024-03-24 15:32:20 -07:00
sp2xdev cb6252b15f Update issue templates 2024-03-24 15:30:09 -07:00
sp2xdev 864eec2391 Update README.md 2024-03-24 01:57:19 -07:00
sp2xdev 56ad570231 Update README.md 2024-03-24 01:54:04 -07:00
sp2xdev 33e0611ccf Create SOURCE_FILES.md 2024-03-18 13:37:37 -07:00
6 changed files with 47 additions and 14 deletions
+4 -4
View File
@@ -8,17 +8,17 @@ assignees: ''
---
## Game and version
<name of game, version of game>
*name of game, version of game*
## Version of spice2x
<version of spice, this can be seen in the About tab, and in log.txt>
*version of spice, this can be seen in the About tab, and in log.txt*
## Laptop
<Are you running this on a laptop? Does it have a hybrid iGPU+ dGPU configuration?>
*Are you running this on a laptop? Does it have a hybrid iGPU+ dGPU configuration?*
## Attached log.txt file, if available
> [!WARNING]
> Please make sure you remove any personally identifiable information from the log file.
## Describe the issue
<what's the issue?>
*what's the issue?*
@@ -0,0 +1,10 @@
---
name: Documentation update
about: For suggesting edits to the wiki page.
title: ''
labels: documentation
assignees: ''
---
+6 -3
View File
@@ -16,10 +16,13 @@ assignees: ''
> Feel free to remove this section after you have read it.
## Description of change
<what does this code do?>
*what does this code do?*
## Compiling
*you must be able to compile with the included Docker script with zero compiler warnings*
## Testing
<how was the code tested?>
*how was the code tested?*
## Patch file
<what patch format are you using? Unix Patch format? Git Patch?>
*what patch format are you using? Unix Patch format? Git Patch?*
+22
View File
@@ -0,0 +1,22 @@
## Contributing
Baseline rules for patch submissions are as follows. Any patches violating the rules below will not be accepted.
### Adding support for games
* No BomberGirl, as long as the Free To Play service is still alive.
* No support for that one touch screen game that dispenses plushies of mouse character (`O26`).
* No support for eaCloud ("Konasute") games.
* 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.
### Code quality requirements
* Test for regressions, at least in and around the component you are modifying:
* All currently supported games / versions must continue to work.
* Backwards compatibility must be preserved, unless there is a really good reason to break it. This includes (but not limited to): global/local config files, command line parameters, game patches, device interop (e.g., card readers), and SpiceAPI / Companion interop.
* Reasonable level of compatibility with the last release of original spicetools is expected. The stated goal of spice2x is to be a drop-in replacement for spicetools.
* Simply put, if someone has an existing install of spicetools/spice2x, copying over new version of spice2x should not result in different behavior or loss of functionality.
* Make sure you compile with the included Docker script and ensure you do not introduce **any** new compiler warnings or build breaks. The Docker script is the standard build environment, your custom Linux build environment or MSVC can be used during development, but you must validate the final build using Docker.
* Do not submit snippets of code as a "patch". Exceptions can be made for trivial changes (correct a typo, fix a single line of code...), but otherwise, a successfully compiled & fully tested patch file is required when submitting for review.
* 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.
+2 -7
View File
@@ -33,12 +33,7 @@ New GitHub accounts are prevented from creating new issues to prevent spam.
Maintainers of this project reserve the right to close or delete any low effort issues.
## Contributing
**We encourage the community to submit patches via the issue tracker for any bug fixes or feature enhancements.** If you want to resolve any reported (or not reported) bugs, implement features, add support for new games, or fix a [known issue](https://github.com/spice2x/spice2x.github.io/wiki/Known-issues) - feel free to reach out via the Issue tracker.
**We encourage the community to submit patches via the issue tracker for any bug fixes or feature enhancements.** If you want to resolve any reported (or not reported) bugs, implement features, add support for new games, or fix a [known issue](https://github.com/spice2x/spice2x.github.io/wiki/Known-issues) - feel free to reach out via the Issue tracker. All submitted code patches are assumed to be GPLv3 compliant.
Baseline rules for adding support for games:
Please see [CONTRIBUTING page](https://github.com/spice2x/spice2x.github.io/blob/main/CONTRIBUTING.md) for a full list of guidelines when submitting code.
* No BomberGirl, as long as the Free To Play service is still alive.
* No support for that one touch screen game that dispenses plushies of mouse character (`O26`).
* No support for eaCloud ("Konasute") games.
* 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.
+3
View File
@@ -0,0 +1,3 @@
As always, this project is **distributed with source per GPLv3 license**. Check the [Releases](https://github.com/spice2x/spice2x.github.io/releases) page.
spice2x team does not use GitHub for source control.