Contributing

Bug reports, fixes and corrections to the handbook are welcome. A change that does one thing is reviewed sooner than a change that does several.

Bug reports

To report a problem, open an issue in the repository of the part that is at fault: the tools, the installer, the recipes, the image builders or the handbook. The repositories are listed in developers. A report must include:

• (a) the version, from cat /etc/os-release, and whether the system is the live ISO, an installation or a manual installation;
• (b) the exact commands and their full output;
• (c) on an installed system, the output of geiger and scram status;
• (d) for a boot failure, the serial log of a QEMU run with -serial stdio, or a photograph of the screen; and
• (e) whether the problem occurs in QEMU with KVM and OVMF or on real hardware.

Security problems

A security problem must be reported through the private vulnerability reporting of the repository on GitHub, and not as a public issue. The report should state what is affected and how to reproduce the problem. A fix is released as a new version, and the news page names the problem once the fix is out. Only the latest release recieves fixes. The protection settings, and their limits, are described in security.

Changes

Changes are sent as pull requests to the repository of the part that you changed. The request should state what the change does.

Handbook

Corrections to the handbook are sent to the uranium-os.github.io repository.

License

The code is in the public domain under CC0 1.0, and a contribution is accepted under the same license.