README.md

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