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 # the dependencies table
  14
  15 https://github.com/microcai/gentoo-zh/blob/deps-table/relation.md
  16
  17 # commit message
  18
  19 * for non-version bump commit, commit message should be like this:
  20
  21         $category/$package: one line short description message
  22         {empty line}
  23         multiple lines of description about why you change this.
  24         if you change to fix the bug, and if there is an GitHub
  25         issue entry for that bug, then point the bug link here.
  26
  27 * for version bump commit, commit message should be like this:
  28
  29         $category/$package: version bump to $new_version
  30
  31 # package review
  32
  33 * I trust contributors that have commit rights, therefore commitors
  34   should think carefully before committing.
  35
  36 * If you want to discuss your commit/patch, push to *another branch* or send a
  37   Pull Request and discuss in the GitHub Issue, mailing list, or talk to the maintainer
  38   directly.
  39
  40 * If you are sending a new pull request, make sure it contains all necessary commits
  41   for a single contribution, e.g. don't send two pull requests for an ebuild and its
  42   `Manifest`.
  43
  44 * Every ebuild change should not produce compile error before
  45   committing.
  46
  47 * Every ebuild should be tested in every ARCH that it KEYWORDS for.
  48   if not, don't claim that you support that keyword.
  49
  50 * If you are writing the ebuild for a font, and you are using stantard font.eclass
  51   to install the font, I could grant an exception for the must-tested-in-every-ARCH
  52   rule. You could use something like
  53
  54   `KEYWORDS="alpha amd64 arm hppa ia64 ppc mips ~s390 ~sh sparc x86 ~x86-fbsd"`
  55
  56   But please don't abuse this exception. It must be a pure font package.
  57
  58 # Distfiles mirror
  59
  60 We provide a distfiles mirror that caches the distfiles in gentoo-zh.
  61
  62 Our server, hosted on Finland:
  63 ```
  64 GENTOO_MIRRORS="${GENTOO_MIRRORS} https://distfiles.gentoocn.org"
  65 ```
  66
  67 Chongqing University mirror:
  68 ```
  69 GENTOO_MIRRORS="${GENTOO_MIRRORS} https://mirrors.cqu.edu.cn/gentoo-zh"
  70 ```
  71
  72 Nanjing University mirror:
  73 ```
  74 GENTOO_MIRRORS="${GENTOO_MIRRORS} https://mirrors.nju.edu.cn/gentoo-zh"
  75 ```
  76
  77 # See wiki for some package not working