ratufacoat/contributing.mkd

   1 # Contributing
   2
   3 Before you contribute you should read and understand the [license](license.mkd)
   4 that SquirrelJME is under. You should abide by the
   5 [Code of Conduct](code-of-conduct.mkd), if you fail to keep the pledge your
   6 contribution will not be accepted since it can create a toxic and unwelcoming
   7 environment for developers and users.
   8
   9  * For instructions on building, see [this document](building.mkd).
  10  * Please read the [developer guide](developer-guide.mkd)!
  11
  12 Development can happen on any operating system, however most of the scripts are
  13 developed targeting Unix compatible systems, this means the following:
  14
  15  * Linux
  16  * BSD
  17  * Mac OS X
  18  * Cygwin or MSYS2 (Windows)
  19
  20 SquirrelJME uses the [Fossil](https://fossil-scm.org/) source control
  21 system and as such it generally is expected that it is to be used. There also
  22 are [GitHub Pull Requests](https://github.com/XerTheSquirrel/SquirrelJME/pulls)
  23 however since the Git is a mirror, when these are merged there will not be
  24 an indication that they were merged because any writes to the Git repository
  25 will be destroyed.
  26
  27 ## Contributor Agreement
  28
  29 **ALL CONTRIBUTORS MUST ACCEPT THE FOLLOWING AGREEMENT BEFORE THEIR CODE WILL**
  30 **BE ACCEPTED IN THE PROJECT. IF THE DEVELOPER IS EMPLOYED AND DEVELOPS THE**
  31 **CODE "ON THE CLOCK" OR UNDER CONTRACT, THEN THAT DEVELOPER MUST SEEK THE**
  32 **PERMISSION OF THE EMPLOYER.**
  33
  34         You grant Stephanie Gawroriski an irrevocable license that:
  35
  36          1. That you own the contributing work.
  37          2. Grants a patent license, as per the GNU GPLv3.
  38          3. Granting Stephanie Gawroriski permission to redistribute, sell, lease,
  39             modify, transform, translate, and relicense the specified works. This
  40             is to simplify the licensing of the project and permit it to be
  41             consistent. Your contribution may be commercially licensed to other
  42             parties supporting the project through this means.
  43          4. If employed by a company, you have a right by that company to provide
  44             contributions to this project.
  45          5. Have pledged to follow the Code of Conduct.
  46          6. Have read and understand the Ettiquite.
  47