You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

91 lines
4.0 KiB

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