README.md

   1 illumos-unleashed
   2
   3 We think that operating systems are very exciting to work on; In particular,
   4 we enjoy working with descendants of OpenSolaris.  Unfortunately, we feel
   5 that the major OpenSolaris fork - illumos - has adopted a contribution
   6 process that hinders development and discourages new contributors from
   7 coming back with more code changes.  Therefore, we created this fork to try
   8 to address these issues.
   9
  10 Goals
  11 =====
  12
  13 While the full list of goals is constantly evolving, the following is a list
  14 of the basic goals which we always strive for.
  15
  16 1. The contribution process must be simple and must encourage new
  17    contributors to repeatedly contribute.
  18 2. We aim to have periodic releases (roughly one every 6 months).  Security
  19    patches will be provided between releases.
  20 3. Unleashed aims to be a modern operating system base.
  21   1. Modern compiler support.  Currently, we support only gcc 4.4.4, however
  22      we hope to allow a wider range of gcc versions.  Eventually, we would
  23      like to be able to use clang as well.
  24   2. The UNIX environment has changed drastically over the past 20 years.
  25      As a result, we hope to ship an environment that provides the comforts
  26      of modern UNIX, yet maintain the unique features we inherited that set
  27      us apart from other UNIX systems out there.
  28   3. POSIX has won.  Therefore, when it does not hinder usability (see item
  29      3.2), we want a system that is POSIX compliant without having to jump
  30      through special hoops (e.g., setting $PATH, or providing extra compiler
  31      flags).
  32   4. We do *not* support "extreme legacy".  While support for legacy
  33      interfaces and binaries is important, it must be done in moderation.
  34      Therefore, old interfaces may be removed from time to time.  Interface
  35      deprecation will be clearly communicated through release notes.
  36 4. Maintaining code is hard enough when the code is squeaky clean.  To make
  37    our job easier, we try to get the code clean when first committing it -
  38    even if it delays the commit a little bit.  In other words, we care about
  39    more than just that the code works - we want code we can (for the most
  40    part) be proud of.
  41 5. XXX: describe the amount of self-contained-ness
  42
  43 Rules
  44 =====
  45
  46 The community organization is based on the FreeBSD community.  (See
  47 docs/organization.md for a more thorough description.)  This style of
  48 community reflects our belief that our community members can behave
  49 responsibly both when communicating with others as well as when committing
  50 code to the repository.  To help guide newcomers, we have created a Code of
  51 Conduct (see docs/code-of-conduct.md) that we expect everyone to abide by.
  52
  53 Commits
  54 -------
  55
  56 Commits are cheap.  Modern revision control systems (e.g., git) handle large
  57 numbers of commits very well.  Therefore small changes that are encouraged
  58 (instead of "mega commits" that seem to touch half the code base).  Smaller
  59 commits make it easier to search through commit history to see what other
  60 parts of the repository were changed as part of the change.
  61
  62 Each commit should build and boot.  Obviously, running nightly and a full
  63 set of tests for each commit is not necessarily practical, however one
  64 should try to avoid commits that break the build.  (Commits that don't build
  65 or boot make it harder to bisect the history to find bad commits.)
  66
  67 For the most part, we use a Linux kernel-style commit messages.  If there is
  68 a bug number reference it.  For example:
  69
  70     subsys: frob the input 7 times
  71
  72     frobbing less than 7 times leads to information disclosure
  73     vulnerability.
  74
  75     illumos bug #123
  76
  77     Spelling of comments fixed up by: Committer Developer <c.d@example.com>