2 Contribution Guidelines
Kevin Lange edited this page 2015-08-26 19:26:23 -07:00

Rule #0: ToaruOS is a hobby project.

We are here to have fun. Don't complain that the build scripts don't work in your set up, or that some part of the kernel is horribly written, or that something is a massive hack. This isn't production software, and I sure don't have time to make sure everything is even good, much less perfect - I work on the things I feel are most fun to work on at the time.

Rule #1: Don't break the GUI.

Massive code cleanups in the kernel are great. It's always nice to see people interested in polishing the turd. That said, don't break the userspace. Test your changes thoroughly and work to maintain backwards compatibility. If you want to fix a system call, make sure you're not changing behavior - and if the expected behavior is wrong, consider adding a new system call. Don't arbitrarily change userspace load offsets, or incompatibly change the formats of structures passed to userspace.

Rule #2: Don't complain about the styleguide.

Some of the rules in the styleguide are intentionally different. Some of them are loose. Either way, don't complain about formatting specified in the styleguide - it does not exist to suit your fancy, it exists to maintain consistency across multiple contributors.