CONTRIBUTING 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. ========================================================================
  2. ------------------------------------------------------------------------
  3. For your contribution to be included in this project, you must
  4. understand and agree to the terms in this document at the time of
  5. contribution.
  6. - A "contribution" consists of all files, patches and changes, source
  7. control commits, comments and other metadata submitted to the project
  8. maintainer(s) for inclusion or other use in the project.
  9. - All contributions must consist only of your own original work, to
  10. which you retain copyright, or to which copyright is not applicable.
  11. - All copyrightable portions must be non-exclusively, perpetually and
  12. irrevocably licensed under the same license terms as the overall
  13. project.
  14. - You will receive attribution in the project's license, in the form of
  15. "Portions (C) ...", which shall cover all portions of all
  16. contributions. You agree that this constitutes adequate attribution
  17. under the terms of the license.
  18. - You may request to be attributed pseudonymously at the time of
  19. submission. Unless otherwise specified, source control metadata
  20. will be used for attribution.
  21. ........................................................................
  22. Other Guidelines:
  23. - Please do not use the nc_* namespace for projects you will be
  24. releasing directly to the public, e.g. via ContentDB, Forums, etc.
  25. This namespace should only be for things that will be included in
  26. the base game.
  27. - Non-included contributions to the project, such as hosting or other
  28. services, content such as videos/streams, screenshots/galleries,
  29. reviews, stories and other publicity do not need to follow the
  30. guidelines above unless they are intended to also be eligible for
  31. inclusion directly in the project.
  32. - Keep original media source files that are not directly used by the
  33. game engine (e.g. *.blend, *.xcf, *.svg) in folders named "src" in the
  34. appropriate mod/area. These will be distributed with the source
  35. repo, but will NOT be packaged by ContentDB to keep download sizes
  36. minimal.
  37. - Lua code formatting/style is using:
  38. https://gitlab.com/Warr1024/luatools
  39. Install the commands in your $PATH, and then in the root of the
  40. project, run this command to format the code:
  41. lualocals -f luaintraspace -f pkluaformat
  42. You can add a -c option to lualocals to make it check only but not
  43. modify your code; the check-only version is very useful in a git
  44. pre-commit hook script.
  45. ------------------------------------------------------------------------
  46. ========================================================================