mirror of
https://github.com/par274/sharpemu.git
synced 2026-07-15 22:22:41 +00:00
2060dacaf1
* [emulator] Fix mitigated child process handling * reuse * [log] log to file for CLI and fix some issues
71 lines
3.6 KiB
Markdown
71 lines
3.6 KiB
Markdown
<!--
|
|
Copyright (C) 2026 SharpEmu Emulator Project
|
|
SPDX-License-Identifier: GPL-2.0-or-later
|
|
-->
|
|
|
|
# Contributing
|
|
|
|
Contributions are always welcome!
|
|
|
|
Before opening a pull request, please keep the following in mind:
|
|
|
|
- Keep PRs small and focused on a single topic.
|
|
- Discuss large architectural changes before implementing them.
|
|
- Follow the project's existing coding style.
|
|
- Do not submit generated code unless you fully understand and can maintain it.
|
|
- Do not introduce Sony proprietary code, firmware, keys, decrypted assets, or other copyrighted PlayStation materials.
|
|
- All reverse engineering should be based on publicly available information, clean-room techniques, or your own original research.
|
|
- Game-specific hacks should be avoided whenever possible. Prefer generic implementations that improve overall compatibility.
|
|
- New features should not break existing behavior.
|
|
- Ensure the project builds successfully before submitting a PR.
|
|
|
|
If you're unsure about a design decision, feel free to open a discussion or draft PR first.
|
|
|
|
## AI-Assisted Contributions
|
|
|
|
AI-assisted development is welcome and may be used for research, reverse engineering, code generation, or documentation.
|
|
|
|
However, contributors are expected to fully understand every line of code they submit. By opening a pull request, you confirm that you are able to explain, modify, debug, and maintain the submitted code without relying on the AI that generated it.
|
|
|
|
When submitting an AI-assisted PR:
|
|
|
|
- Clearly explain **what the change does**, **why it is needed**, and **what problem it solves**, using your own words.
|
|
- Describe **how you verified the change**, including the games, applications, or test cases used.
|
|
- Avoid excessive product-level logging. Use logging only when it provides meaningful diagnostic value.
|
|
- Comments should document design decisions or implementation details in your own words. Avoid generic AI-generated comments that merely restate what the code already does.
|
|
- Be prepared to answer review questions about the implementation. "The AI generated it" is not considered a sufficient explanation.
|
|
- Large AI-generated changes without a clear understanding of the implementation are unlikely to be accepted.
|
|
- If the implementation cannot be reasonably explained during code review, the pull request may be rejected regardless of whether it works.
|
|
|
|
The quality, correctness, maintainability, and long-term ownership of the submitted code remain the responsibility of the contributor.
|
|
|
|
## Coding Style
|
|
|
|
SharpEmu follows a consistent coding style across the project. Please ensure your contributions match the existing style.
|
|
|
|
- Use **4 spaces** for indentation (no tabs).
|
|
- Use **2 spaces** for XML-based files (e.g. `.csproj`, `.props`, `.targets`, `.xml`, `yml`, GitHub workflow files where applicable).
|
|
- Respect the project's `.editorconfig`.
|
|
- Ensure every text file ends with a **single trailing newline**
|
|
- Avoid formatting-only commits unless they are the purpose of the PR.
|
|
- Keep naming, formatting, and file organization consistent with the surrounding code.
|
|
- Prefer small, focused changes over large refactors.
|
|
|
|
### REUSE Compliance
|
|
|
|
This repository follows the REUSE Specification.
|
|
|
|
Every new file must contain the appropriate SPDX license header. Pull requests that do not comply with the project's REUSE requirements will fail CI and will not be merged.
|
|
|
|
### Recommended Development Environment
|
|
|
|
The repository includes an `.editorconfig` and Visual Studio solution files.
|
|
|
|
For the best experience, we recommend using:
|
|
|
|
- Visual Studio Code with;
|
|
- C#
|
|
- C# Dev Kit
|
|
|
|
Most editors that support `.editorconfig` will automatically apply the project's formatting rules.
|