CONTRIBUTING.md

   1 # Contributing Guidelines
   2
   3 Patches and pull-requests:
   4
   5 If you want to contribute a change to LuCI, please either send a patch using git send-email
   6 or open a pull request against the openwrt/luci repository.
   7
   8 Regardless of whether you send a patch or open a pull request, please try to follow these rules:
   9
  10 * Have a useful subject prefixed with the component name
  11     (E.g.: "modules/admin-full: fix wifi channel selection on multiple STA networks")
  12 * Shortly explain the changes made and - if applicable - the reasoning behind them
  13 * Include Signed-off-by in the comment
  14     (See <https://dev.openwrt.org/wiki/SubmittingPatches#a10.Signyourwork>)
  15
  16 In case you like to send patches by mail, please use the [LuCI mailinglist](https://lists.subsignal.org/mailman/listinfo/luci)
  17 or the [OpenWrt Development List](https://lists.openwrt.org/cgi-bin/mailman/listinfo/openwrt-devel).
  18
  19 If you send via the OpenWrt list, include a "[luci]" tag in your subject line.
  20 For general information on patch submission, follow the [OpenWrt patch submission guideline](https://dev.openwrt.org/wiki/SubmittingPatches).
  21
  22
  23 If you have commit access:
  24
  25 * Do NOT use git push --force.
  26 * Use Pull Requests if you are unsure and to suggest changes to other developers.
  27
  28 Gaining commit access:
  29
  30 * Commit access will be granted to responsible contributors who have made
  31   useful pull requests and / or feedback or patches to this repository or
  32   OpenWrt in general. Please include your request for commit access in your
  33   next pull request or ticket.
  34
  35 Release Branches:
  36
  37 * Branches named "luci-X.Y" (e.g. luci-0.12) are release branches.
  38 * These branches are built with the respective OpenWrt release and are created
  39   during the release stabilisation phase.
  40 * Please ONLY cherry-pick or commit security and bug-fixes to these branches.
  41 * Do NOT add new packages and do NOT do major upgrades of packages here.
  42 * If you are unsure if your change is suitable, please use a pull request.
  43