Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 3.93 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 3.93 KB
Raw

Contributing to touchHLE

General

Please be kind and respectful to others.

It's especially important to value and respect others' time and energy: don't demand or expect anything to happen on any particular timescale, or even for anyone to do anything at all. We're all volunteers here, doing things for the love of it, and if you force us to spend a lot of time on you, it's going to slowly chip away at our passion and enthusiasm.

⚠️ Do not link to pirated content. “Abandonware” is also pirated content.
⚠️ Do not link to illegal copies of applications that were released for free. These are also considered pirated content.
⚠️ Do not ask about how to obtain pirated content.
⚠️ Do not talk about using pirated content.
⚠️ You will be banned if you ignore this warning.

Issues

Please bear in mind that there are infinitely many apps that do not work in touchHLE right now, so please don't open issues about apps that aren't in the supported list, unless you've got it partially working (e.g. loaded up to the menu but the main game doesn't work). The fact that an app's splash screen (Default.png) shows up doesn't mean it's partially working.

Code contributions

BUILDING.md and DEBUGGING.md might be helpful while you're working on a contribution.

Please run cargo fmt and cargo clippy on your changes before committing. For the handful of C and C++ files, please use clang-format -i to format them.

If you're going to open a pull request with non-trivial changes, please talk to us first so we can figure out if we're likely to accept them. It would be a shame if your effort had to be wasted.

Copyright and reverse engineering

⚠️ Be very careful about copyright. To put it simply: don't contribute if you've seen code you shouldn't have seen, don't copy code that isn't yours to copy, and especially don't secretly copy and pretend you didn't. Any infringement of Apple or other copyrights could threaten the foundations of the project, and the livelihoods of current contributors. If in doubt, don't do it, but in particular:

  • ⚠️ When implementing an API, rely firstly and primarily on public documentation.
  • ⚠️ Do not under any circumstances look at or rely on leaked code, documentation, tools, etc. Material being available somewhere does not mean it is open-source.
  • ⚠️ Do not disassemble or decompile components of iPhone OS or other Apple platforms. If you can't figure out how else you would find out how an API should behave, please just don't try to implement it.
  • ⚠️ Looking at header files is occasionally necessary, but it should not be your first resort, and you must only use them as a source of simple facts (e.g. what value does a constant have, what type does a type alias resolve to). Do not copy their layout and organization. Do not copy anything you do not need to. Except where the name is part of the ABI or public API, do not copy names.
  • ⚠️ Bear in mind that open-source code is still covered by copyright, and so the same caution applies to consulting open-source code. Especially try to avoid looking at the implementation files, unless there is no other option, and do not copy algorithms. (Note however that if it's under a compatible license, we may be able to bring the open-source code into the project under that license, as a dependency.)
  • ⚠️ If you work or have worked at Apple, or NeXT, or various other organisations, then you may have seen the proprietary source code used in components of iPhone OS. If that's the case, please do not contribute to this project.
  • ⚠️ If your employment contract or applicable law in your country means that you don't own the copyright on code you want to contribute to this project, or if for some other reason you may need permission from your employer to contribute to this project: please do obtain that permission before contributing.