README.md

   1 # rule no.1
   2
   3 DO NOT BREAK PEOPLE'S SYSTEM
   4
   5 # rule no.2
   6
   7 DO NOT BREAK PEOPLE'S SYSTEM
   8
   9 # rule no.3
  10
  11 follow rule no.1 and no.2
  12
  13 # commit message
  14
  15 * for non-version bump commit, commit message should be like this:
  16
  17         $category/$package: one line short description message
  18         {empty line}
  19         multiple lines of description about why you change this.
  20         if you change to fix the bug, and if there is an GitHub
  21         issue entry for that bug, then point the bug link here.
  22
  23 * for version bump commit, commit message should be like this:
  24
  25         $category/$package: version bump to $new_version
  26
  27 # package review
  28
  29 * I trust contributors that have commit rights, therefore commitors
  30   should think carfully before committing.
  31
  32 * If you want to discuss your commit/patch, push to *another branch* or send a
  33   Pull Request and discuss in the GitHub Issue, mailing list, or talk to the maintainer
  34   directly.
  35
  36 * If you are sending a new pull request, make sure it contains all necessary commits
  37   for a single contribution, e.g. don't send two pull requsets for an ebuild and its
  38   `Manifest`.
  39
  40 * Every ebuild change should not produce compile error before
  41   committing.
  42
  43 * Every ebuild should be tested in every ARCH that it KEYWORDS for.
  44   if not, don't claim that you support that keyword.
  45
  46 * If you are writing the ebuild for a font, and you are using stantard font.eclass
  47   to install the font, I could grant an exception for the must-tested-in-every-ARCH
  48   rule. You could use something like
  49
  50   `KEYWORDS="alpha amd64 arm hppa ia64 ppc mips ~s390 ~sh sparc x86 ~x86-fbsd"`
  51
  52   But please don't abuse this exception. It must be a pure font package.
  53
  54   # See wiki for some package not working