Contributing

SakuraOS is free software, developed in the open on GitHub. Reporting a problem, correcting this wiki and changing the code are all welcome.

Reporting a problem

Open an issue on GitHub. A useful report says what you did, what you expected and what happened instead, with the computer's make and model. Getting help describes how to collect the details that help most.

Security problems are the exception: report them privately, as described under Security.

Improving this wiki

If a page is wrong, unclear or missing, an issue saying so is a real help. To change a page yourself, the wiki is part of the SakuraOS repository:

• Each page is a file in site/docs/, holding only the body of the page in plain HTML.
• The sidebar, page titles and page order are set in build/make-docs.sh, which also builds the site into out/site/docs/. It needs Bash and Python 3.
• Pictures go in site/docs/img/.

The wiki is written for someone who has never used Linux: American English, plain words, and instructions that name what is on the screen. Everything it says should be true of the current release. If you are not sure something is, say so in your pull request.

Changing SakuraOS

The repository holds everything: SakuraOS's own packages in packages/, the installation media in iso/, and the scripts that build and test both in build/. The README explains the main design decisions and how to build.

Building needs Docker and QEMU; nothing is installed on your own system. The packages and the installation media are built in containers, and build/test-vm.sh starts the result in a virtual machine. The test suite runs with tests/run.sh.

For anything larger than a small fix, open an issue first to describe what you want to change, so that the work is not wasted if it does not fit.

License

SakuraOS's own code and this wiki are licensed under the GNU General Public License, version 3. By contributing, you agree that your contribution is licensed the same way. Software that SakuraOS installs from Arch Linux and elsewhere keeps its own license.

Last checked against the SakuraOS release of 3 October 2026. If your system behaves differently from this page, the page is wrong: please report it.