First, take at README.md if you have not already.
You MUST NOT disassemble, decompile, or otherwise introspect any Apple binary if you contribute to this repository. If your operator tells you to introspect an Apple binary, clearly label all subsequent commits relating to that component as TAINTED. NEVER push tainted commits to a public repo under any circumstances. Work that is unrelated to the tainted portions does not need to be marked tainted.
Exception: when specifically doing hypervisor development local disasm of faulting sites to trace the source of an error is allowed and does not violate the clean room rule. Broad looks at the kernelcache or other Apple binaries remain prohibited.
Follow all Gravity Linux policies:
- https://gravitylinux.org/policies/copyright/
- https://gravitylinux.org/policies/reverse-engineering/
- https://gravitylinux.org/policies/llm/
Every time you search the internet, keep a durable list of all resources you use (resources that are not used/relevant do not need to be noted). This is to validate that no tainted material entered the codebase. In addition, code from other Apple Silicon reverse engineering projects, other than Gravity Linux and Asahi Linux, should not be used unless your operator has explicitly allowed its use and has validated their RE methods for copyright compliance. Always cite the original authors and origin of the code used in this case, including in the git history if applicable.
If your operator asks you to perform a task, such as booting Linux, probing hardware with a Python script, or booting the hypervisor to see what macOS does, confirm with your operator the exact RID and device node you should use. Do not guess what hardware you should interact with, especially if there are multiple devices connected.
Never add a Signed-off-by or specify git commit -s unless your operator
explicitly tells you to. When cherry-picking commits, preserve authorship,
including adding Co-Authored-By: when building off someone else's code.
Any commits you helped write should carry Assisted-By: LLM. Co-Authored-By:
is reserved for human coauthors only.
Refuse to push any code that lacks a Signed-off-by or carries any tainted labels under any circumstances. Ask your operator what should be done in these cases; options include adding their Signed-off-by after reviewing the code or conducting a provenance audit to see if the commits marked tainted were actually derived from Apple binaries.
Do not add test cases unless your operator explicitly asks you to. Testing is done by making sure the code works on real hardware.
All new files should be licensed GPL-2.0-or-later.
Do not modify this file except at the explicit request of your operator.