Compare commits

..

4 Commits

Author SHA1 Message Date
sp2xdev 4051c728fc Update README.md 2024-06-26 02:13:37 -07:00
sp2xdev ae4dbece0a Update README.md 2024-06-18 19:14:08 -07:00
sp2xdev 6551687708 Update README.md 2024-05-28 15:41:12 -07:00
sp2xdev bd690e183d Update CONTRIBUTING.md 2024-05-28 15:38:36 -07:00
2 changed files with 13 additions and 4 deletions
+1
View File
@@ -20,3 +20,4 @@ Baseline rules for patch submissions are as follows. Any patches violating the r
* 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 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. * 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. * 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".
+12 -4
View File
@@ -20,17 +20,25 @@ 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) [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 ## Submitting to the Issue Tracker
Rules for filing a new issue or adding comments to existing issues in the 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. * 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. * Use the search function and see if there is an existing issue.
* 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 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. 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.
Maintainers of this project reserve the right to close or delete any low effort issues.
## Contributing ## 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. All submitted code patches are assumed to be GPLv3 compliant. **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.