CONTRIBUTING.md

   1 # Contributing Guidelines
   2 (See <http://wiki.openwrt.org/doc/devel/packages> for overall format and construction)
   3
   4 All packages you commit or submit by pull-request should follow these simple guidelines:
   5
   6 * Package a version which is still maintained by the upstream author.
   7 * Will be updated regularly to maintained and supported versions.
   8 * Have no dependencies outside the OpenWrt core packages or this repository feed.
   9 * Have been tested to compile with the correct includes and dependencies. Also, test with "Compile with full language support" found under "General Build Settings" set.
  10 * Best of all -- it works as expected!
  11
  12 Makefile contents should contain:
  13
  14 * An up-to-date copyright notice. Use OpenWrt if no other present or supply your own.
  15 * A (PKG_)MAINTAINER definition listing either yourself or another person in the field.
  16     (E.g.: PKG_MAINTAINER:= Joe D. Hacker `<jdh@jdhs-email-provider.org`>)
  17 * A PKG_LICENSE tag declaring the main license of the package.
  18     (E.g.: PKG_LICENSE:=GPL-2.0+) Please use SPDX identifiers if possible (see list at the bottom).
  19 * An optional PKG_LICENSE_FILE including the filename of the license-file in the source-package.
  20     (E.g.: PKG_LICENSE_FILE:=COPYING)
  21
  22 Commits and pull-requests:
  23
  24 * Have a useful description prefixed with the package name
  25     (E.g.: "foopkg: Add libzot dependency")
  26 * Include Signed-off-by in the comment
  27     (See <https://dev.openwrt.org/wiki/SubmittingPatches#a10.Signyourwork>)
  28
  29 If you have commit access:
  30
  31 * Do NOT use git push --force.
  32 * Do NOT commit to other maintainer's packages without their consent.
  33 * Use Pull Requests if you are unsure and to suggest changes to other maintainers.
  34
  35 Gaining commit access:
  36
  37 * We will gladly grant commit access to responsible contributors who have made
  38   useful pull requests and / or feedback or patches to this repository or
  39   OpenWrt in general. Please include your request for commit access in your
  40   next pull request or ticket.
  41
  42 Release Branches:
  43
  44 * Branches named "for-XX.YY" (e.g. for-14.07) are release branches.
  45 * These branches are built with the respective OpenWrt release and are created
  46   during the release stabilisation phase.
  47 * Please ONLY cherry-pick or commit security and bug-fixes to these branches.
  48 * Do NOT add new packages and do NOT do major upgrades of packages here.
  49 * If you are unsure if your change is suitable, please use a pull request.
  50
  51 ####Common LICENSE tags (short list)
  52 (Complete list can be found at: <http://spdx.org/licenses>)
  53 ####
  54
  55 | Full Name | Identifier  |
  56 |---|:---|
  57 |Apache License 1.0|Apache-1.0|
  58 |Apache License 1.1|Apache-1.1|
  59 |Apache License 2.0|Apache-2.0|
  60 |Artistic License 1.0|Artistic-1.0|
  61 |Artistic License 1.0 (Perl)|Artistic-1.0-Perl|
  62 |Artistic License 1.0 w/clause 8|Artistic-1.0-cl8|
  63 |Artistic License 2.0|Artistic-2.0|
  64 |BSD 2-clause "Simplified" License|BSD-2-Clause|
  65 |BSD 2-clause FreeBSD License|BSD-2-Clause-FreeBSD|
  66 |BSD 2-clause NetBSD License|BSD-2-Clause-NetBSD|
  67 |BSD 3-clause "New" or "Revised" License|BSD-3-Clause|
  68 |BSD 3-clause Clear License|BSD-3-Clause-Clear|
  69 |BSD 4-clause "Original" or "Old" License|BSD-4-Clause|
  70 |BSD Protection License|BSD-Protection|
  71 |BSD with attribution|BSD-3-Clause-Attribution|
  72 |BSD-4-Clause (University of California-Specific)|BSD-4-Clause-UC|
  73 |GNU General Public License v1.0 only|GPL-1.0|
  74 |GNU General Public License v1.0 or later|GPL-1.0+|
  75 |GNU General Public License v2.0 only|GPL-2.0|
  76 |GNU General Public License v2.0 or later|GPL-2.0+|
  77 |GNU General Public License v3.0 only|GPL-3.0|
  78 |GNU General Public License v3.0 or later|GPL-3.0+|
  79 |GNU Lesser General Public License v2.1 only|LGPL-2.1|
  80 |GNU Lesser General Public License v2.1 or later|LGPL-2.1+|
  81 |GNU Lesser General Public License v3.0 only|LGPL-3.0|
  82 |GNU Lesser General Public License v3.0 or later|LGPL-3.0+|
  83 |GNU Library General Public License v2 only|LGPL-2.0|
  84 |GNU Library General Public License v2 or later|LGPL-2.0+|
  85 |Fair License|Fair|
  86 |ISC License|ISC|
  87 |MIT License|MIT|
  88 |No Limit Public License|NLPL|
  89 |OpenSSL License|OpenSSL|
  90 |X11 License|X11|
  91 |zlib License|Zlib|