Artifact f85f1258c34c2accd5a406b986e65994792823bb:
- File bvm/contributing.mkd — part of check-in [9248eac8ce] at 2021-04-01 23:49:37 on branch wip-bvm — Base for BVM. (user: stephanie.gawroriski size: 2759)
- File contributing.mkd — part of check-in [da935c7872] at 2019-01-01 15:05:10 on branch trunk — Add developer guide which is used for making releases. (user: stephanie.gawroriski size: 2759)
- File ratufacoat/contributing.mkd — part of check-in [c70d66dcdb] at 2019-01-15 02:19:43 on branch trunk — Add base project for RatufaCoat. (user: stephanie.gawroriski size: 2759)
0000: 23 20 43 6f 6e 74 72 69 62 75 74 69 6e 67 0a 0a # Contributing.. 0010: 42 65 66 6f 72 65 20 79 6f 75 20 63 6f 6e 74 72 Before you contr 0020: 69 62 75 74 65 20 79 6f 75 20 73 68 6f 75 6c 64 ibute you should 0030: 20 72 65 61 64 20 61 6e 64 20 75 6e 64 65 72 73 read and unders 0040: 74 61 6e 64 20 74 68 65 20 5b 6c 69 63 65 6e 73 tand the [licens 0050: 65 5d 28 6c 69 63 65 6e 73 65 2e 6d 6b 64 29 0a e](license.mkd). 0060: 74 68 61 74 20 53 71 75 69 72 72 65 6c 4a 4d 45 that SquirrelJME 0070: 20 69 73 20 75 6e 64 65 72 2e 20 59 6f 75 20 73 is under. You s 0080: 68 6f 75 6c 64 20 61 62 69 64 65 20 62 79 20 74 hould abide by t 0090: 68 65 0a 5b 43 6f 64 65 20 6f 66 20 43 6f 6e 64 he.[Code of Cond 00a0: 75 63 74 5d 28 63 6f 64 65 2d 6f 66 2d 63 6f 6e uct](code-of-con 00b0: 64 75 63 74 2e 6d 6b 64 29 2c 20 69 66 20 79 6f duct.mkd), if yo 00c0: 75 20 66 61 69 6c 20 74 6f 20 6b 65 65 70 20 74 u fail to keep t 00d0: 68 65 20 70 6c 65 64 67 65 20 79 6f 75 72 0a 63 he pledge your.c 00e0: 6f 6e 74 72 69 62 75 74 69 6f 6e 20 77 69 6c 6c ontribution will 00f0: 20 6e 6f 74 20 62 65 20 61 63 63 65 70 74 65 64 not be accepted 0100: 20 73 69 6e 63 65 20 69 74 20 63 61 6e 20 63 72 since it can cr 0110: 65 61 74 65 20 61 20 74 6f 78 69 63 20 61 6e 64 eate a toxic and 0120: 20 75 6e 77 65 6c 63 6f 6d 69 6e 67 0a 65 6e 76 unwelcoming.env 0130: 69 72 6f 6e 6d 65 6e 74 20 66 6f 72 20 64 65 76 ironment for dev 0140: 65 6c 6f 70 65 72 73 20 61 6e 64 20 75 73 65 72 elopers and user 0150: 73 2e 0a 0a 20 2a 20 46 6f 72 20 69 6e 73 74 72 s... * For instr 0160: 75 63 74 69 6f 6e 73 20 6f 6e 20 62 75 69 6c 64 uctions on build 0170: 69 6e 67 2c 20 73 65 65 20 5b 74 68 69 73 20 64 ing, see [this d 0180: 6f 63 75 6d 65 6e 74 5d 28 62 75 69 6c 64 69 6e ocument](buildin 0190: 67 2e 6d 6b 64 29 2e 0a 20 2a 20 50 6c 65 61 73 g.mkd).. * Pleas 01a0: 65 20 72 65 61 64 20 74 68 65 20 5b 64 65 76 65 e read the [deve 01b0: 6c 6f 70 65 72 20 67 75 69 64 65 5d 28 64 65 76 loper guide](dev 01c0: 65 6c 6f 70 65 72 2d 67 75 69 64 65 2e 6d 6b 64 eloper-guide.mkd 01d0: 29 21 0a 0a 44 65 76 65 6c 6f 70 6d 65 6e 74 20 )!..Development 01e0: 63 61 6e 20 68 61 70 70 65 6e 20 6f 6e 20 61 6e can happen on an 01f0: 79 20 6f 70 65 72 61 74 69 6e 67 20 73 79 73 74 y operating syst 0200: 65 6d 2c 20 68 6f 77 65 76 65 72 20 6d 6f 73 74 em, however most 0210: 20 6f 66 20 74 68 65 20 73 63 72 69 70 74 73 20 of the scripts 0220: 61 72 65 0a 64 65 76 65 6c 6f 70 65 64 20 74 61 are.developed ta 0230: 72 67 65 74 69 6e 67 20 55 6e 69 78 20 63 6f 6d rgeting Unix com 0240: 70 61 74 69 62 6c 65 20 73 79 73 74 65 6d 73 2c patible systems, 0250: 20 74 68 69 73 20 6d 65 61 6e 73 20 74 68 65 20 this means the 0260: 66 6f 6c 6c 6f 77 69 6e 67 3a 0a 0a 20 2a 20 4c following:.. * L 0270: 69 6e 75 78 0a 20 2a 20 42 53 44 0a 20 2a 20 4d inux. * BSD. * M 0280: 61 63 20 4f 53 20 58 0a 20 2a 20 43 79 67 77 69 ac OS X. * Cygwi 0290: 6e 20 6f 72 20 4d 53 59 53 32 20 28 57 69 6e 64 n or MSYS2 (Wind 02a0: 6f 77 73 29 0a 0a 53 71 75 69 72 72 65 6c 4a 4d ows)..SquirrelJM 02b0: 45 20 75 73 65 73 20 74 68 65 20 5b 46 6f 73 73 E uses the [Foss 02c0: 69 6c 5d 28 68 74 74 70 73 3a 2f 2f 66 6f 73 73 il](https://foss 02d0: 69 6c 2d 73 63 6d 2e 6f 72 67 2f 29 20 73 6f 75 il-scm.org/) sou 02e0: 72 63 65 20 63 6f 6e 74 72 6f 6c 0a 73 79 73 74 rce control.syst 02f0: 65 6d 20 61 6e 64 20 61 73 20 73 75 63 68 20 69 em and as such i 0300: 74 20 67 65 6e 65 72 61 6c 6c 79 20 69 73 20 65 t generally is e 0310: 78 70 65 63 74 65 64 20 74 68 61 74 20 69 74 20 xpected that it 0320: 69 73 20 74 6f 20 62 65 20 75 73 65 64 2e 20 54 is to be used. T 0330: 68 65 72 65 20 61 6c 73 6f 0a 61 72 65 20 5b 47 here also.are [G 0340: 69 74 48 75 62 20 50 75 6c 6c 20 52 65 71 75 65 itHub Pull Reque 0350: 73 74 73 5d 28 68 74 74 70 73 3a 2f 2f 67 69 74 sts](https://git 0360: 68 75 62 2e 63 6f 6d 2f 58 65 72 54 68 65 53 71 hub.com/XerTheSq 0370: 75 69 72 72 65 6c 2f 53 71 75 69 72 72 65 6c 4a uirrel/SquirrelJ 0380: 4d 45 2f 70 75 6c 6c 73 29 0a 68 6f 77 65 76 65 ME/pulls).howeve 0390: 72 20 73 69 6e 63 65 20 74 68 65 20 47 69 74 20 r since the Git 03a0: 69 73 20 61 20 6d 69 72 72 6f 72 2c 20 77 68 65 is a mirror, whe 03b0: 6e 20 74 68 65 73 65 20 61 72 65 20 6d 65 72 67 n these are merg 03c0: 65 64 20 74 68 65 72 65 20 77 69 6c 6c 20 6e 6f ed there will no 03d0: 74 20 62 65 0a 61 6e 20 69 6e 64 69 63 61 74 69 t be.an indicati 03e0: 6f 6e 20 74 68 61 74 20 74 68 65 79 20 77 65 72 on that they wer 03f0: 65 20 6d 65 72 67 65 64 20 62 65 63 61 75 73 65 e merged because 0400: 20 61 6e 79 20 77 72 69 74 65 73 20 74 6f 20 74 any writes to t 0410: 68 65 20 47 69 74 20 72 65 70 6f 73 69 74 6f 72 he Git repositor 0420: 79 0a 77 69 6c 6c 20 62 65 20 64 65 73 74 72 6f y.will be destro 0430: 79 65 64 2e 0a 0a 23 23 20 43 6f 6e 74 72 69 62 yed...## Contrib 0440: 75 74 6f 72 20 41 67 72 65 65 6d 65 6e 74 0a 0a utor Agreement.. 0450: 2a 2a 41 4c 4c 20 43 4f 4e 54 52 49 42 55 54 4f **ALL CONTRIBUTO 0460: 52 53 20 4d 55 53 54 20 41 43 43 45 50 54 20 54 RS MUST ACCEPT T 0470: 48 45 20 46 4f 4c 4c 4f 57 49 4e 47 20 41 47 52 HE FOLLOWING AGR 0480: 45 45 4d 45 4e 54 20 42 45 46 4f 52 45 20 54 48 EEMENT BEFORE TH 0490: 45 49 52 20 43 4f 44 45 20 57 49 4c 4c 2a 2a 0a EIR CODE WILL**. 04a0: 2a 2a 42 45 20 41 43 43 45 50 54 45 44 20 49 4e **BE ACCEPTED IN 04b0: 20 54 48 45 20 50 52 4f 4a 45 43 54 2e 20 49 46 THE PROJECT. IF 04c0: 20 54 48 45 20 44 45 56 45 4c 4f 50 45 52 20 49 THE DEVELOPER I 04d0: 53 20 45 4d 50 4c 4f 59 45 44 20 41 4e 44 20 44 S EMPLOYED AND D 04e0: 45 56 45 4c 4f 50 53 20 54 48 45 2a 2a 0a 2a 2a EVELOPS THE**.** 04f0: 43 4f 44 45 20 22 4f 4e 20 54 48 45 20 43 4c 4f CODE "ON THE CLO 0500: 43 4b 22 20 4f 52 20 55 4e 44 45 52 20 43 4f 4e CK" OR UNDER CON 0510: 54 52 41 43 54 2c 20 54 48 45 4e 20 54 48 41 54 TRACT, THEN THAT 0520: 20 44 45 56 45 4c 4f 50 45 52 20 4d 55 53 54 20 DEVELOPER MUST 0530: 53 45 45 4b 20 54 48 45 2a 2a 0a 2a 2a 50 45 52 SEEK THE**.**PER 0540: 4d 49 53 53 49 4f 4e 20 4f 46 20 54 48 45 20 45 MISSION OF THE E 0550: 4d 50 4c 4f 59 45 52 2e 2a 2a 0a 0a 09 59 6f 75 MPLOYER.**...You 0560: 20 67 72 61 6e 74 20 4d 75 6c 74 69 2d 50 68 61 grant Multi-Pha 0570: 73 69 63 20 41 70 70 6c 69 63 61 74 69 6f 6e 73 sic Applications 0580: 20 61 6e 64 20 53 74 65 70 68 61 6e 69 65 20 47 and Stephanie G 0590: 61 77 72 6f 72 69 73 6b 69 20 61 6e 20 69 72 72 awroriski an irr 05a0: 65 76 6f 63 61 62 6c 65 0a 09 6c 69 63 65 6e 73 evocable..licens 05b0: 65 20 74 68 61 74 3a 0a 09 0a 09 20 31 2e 20 47 e that:.... 1. G 05c0: 72 61 6e 74 73 20 61 20 70 61 74 65 6e 74 20 6c rants a patent l 05d0: 69 63 65 6e 73 65 2c 20 61 73 20 70 65 72 20 74 icense, as per t 05e0: 68 65 20 47 4e 55 20 47 50 4c 76 33 2e 0a 09 20 he GNU GPLv3... 05f0: 32 2e 20 54 68 65 20 6c 69 63 65 6e 73 65 20 6f 2. The license o 0600: 66 20 74 68 65 20 63 6f 64 65 20 79 6f 75 20 61 f the code you a 0610: 72 65 20 63 6f 6e 74 72 69 62 75 74 69 6e 67 20 re contributing 0620: 69 73 20 6f 6e 65 20 6f 66 3a 0a 09 20 20 20 20 is one of:.. 0630: 31 2e 20 50 75 62 6c 69 63 20 44 6f 6d 61 69 6e 1. Public Domain 0640: 0a 09 20 20 20 20 32 2e 20 47 4e 55 20 47 50 4c .. 2. GNU GPL 0650: 76 33 2c 20 43 43 2d 42 59 2d 53 41 20 34 2e 30 v3, CC-BY-SA 4.0 0660: 2c 20 6f 72 20 53 49 4c 20 4f 46 4c 20 76 31 2e , or SIL OFL v1. 0670: 31 20 61 70 70 72 6f 70 72 69 61 74 65 6c 79 2e 1 appropriately. 0680: 0a 09 20 20 20 20 33 2e 20 47 72 61 6e 74 69 6e .. 3. Grantin 0690: 67 20 4d 75 6c 74 69 2d 50 68 61 73 69 63 20 41 g Multi-Phasic A 06a0: 70 70 6c 69 63 61 74 69 6f 6e 73 20 61 6e 64 20 pplications and 06b0: 53 74 65 70 68 61 6e 69 65 20 47 61 77 72 6f 72 Stephanie Gawror 06c0: 69 73 6b 69 20 74 68 65 0a 09 20 20 20 20 20 20 iski the.. 06d0: 20 61 62 69 6c 69 74 79 20 74 6f 20 72 65 2d 6c ability to re-l 06e0: 69 63 65 6e 73 65 20 74 68 65 20 77 6f 72 6b 20 icense the work 06f0: 77 69 74 68 6f 75 74 20 61 6e 79 20 63 6f 6e 64 without any cond 0700: 69 74 69 6f 6e 73 20 61 6e 64 20 77 69 74 68 6f itions and witho 0710: 75 74 0a 09 20 20 20 20 20 20 20 61 6e 79 20 61 ut.. any a 0720: 70 70 72 6f 76 61 6c 20 6f 72 20 6e 6f 74 69 63 pproval or notic 0730: 65 2e 20 45 66 66 65 63 74 69 76 65 6c 79 20 67 e. Effectively g 0740: 69 66 74 69 6e 67 20 79 6f 75 72 20 6f 77 6e 20 ifting your own 0750: 63 6f 64 65 20 74 6f 20 74 68 65 0a 09 20 20 20 code to the.. 0760: 20 20 20 20 70 72 6f 6a 65 63 74 20 61 6e 64 20 project and 0770: 67 69 76 69 6e 67 20 66 75 6c 6c 20 66 72 65 65 giving full free 0780: 64 6f 6d 20 66 6f 72 20 74 68 61 74 20 63 6f 64 dom for that cod 0790: 65 2e 0a 09 20 32 2e 20 53 70 65 63 69 66 69 65 e... 2. Specifie 07a0: 64 20 74 68 61 74 20 79 6f 75 20 68 61 76 65 20 d that you have 07b0: 6e 6f 74 20 64 65 72 69 76 65 64 20 79 6f 75 72 not derived your 07c0: 20 63 6f 6e 74 72 69 62 75 74 69 6f 6e 20 61 6e contribution an 07d0: 64 2f 6f 72 20 6b 6e 6f 77 6c 65 64 67 65 0a 09 d/or knowledge.. 07e0: 20 20 20 20 66 72 6f 6d 20 74 68 65 20 73 70 65 from the spe 07f0: 63 69 66 69 65 64 20 76 69 72 74 75 61 6c 20 6d cified virtual m 0800: 61 63 68 69 6e 65 20 69 6d 70 6c 65 6d 65 6e 74 achine implement 0810: 61 74 69 6f 6e 73 20 76 69 61 20 64 69 72 65 63 ations via direc 0820: 74 0a 09 20 20 20 20 73 6f 75 72 63 65 20 63 6f t.. source co 0830: 64 65 20 6f 72 20 72 65 76 65 72 73 65 20 65 6e de or reverse en 0840: 67 69 6e 65 65 72 69 6e 67 20 28 62 75 74 20 6e gineering (but n 0850: 6f 74 20 6c 69 6d 69 74 65 64 20 74 6f 29 3a 0a ot limited to):. 0860: 09 20 20 20 20 2a 20 41 6e 64 72 6f 69 64 20 28 . * Android ( 0870: 47 6f 6f 67 6c 65 29 0a 09 20 20 20 20 2a 20 41 Google).. * A 0880: 70 61 63 68 65 20 48 61 72 6d 6f 6e 79 20 28 41 pache Harmony (A 0890: 70 61 63 68 65 20 46 6f 75 6e 64 61 74 69 6f 6e pache Foundation 08a0: 29 0a 09 20 20 20 20 2a 20 43 56 4d 20 28 53 75 ).. * CVM (Su 08b0: 6e 20 4d 69 63 72 6f 73 79 73 74 65 6d 73 2f 4f n Microsystems/O 08c0: 72 61 63 6c 65 29 0a 09 20 20 20 20 2a 20 45 78 racle).. * Ex 08d0: 63 65 6c 73 69 6f 72 20 4a 45 54 20 28 45 78 63 celsior JET (Exc 08e0: 65 6c 73 69 6f 72 20 4c 4c 43 29 0a 09 20 20 20 elsior LLC).. 08f0: 20 2a 20 47 4e 55 20 43 6c 61 73 73 70 61 74 68 * GNU Classpath 0900: 20 28 46 72 65 65 20 53 6f 66 74 77 61 72 65 20 (Free Software 0910: 46 6f 75 6e 64 61 74 69 6f 6e 29 0a 09 20 20 20 Foundation).. 0920: 20 2a 20 47 4e 55 20 47 43 4a 2f 47 49 4a 20 28 * GNU GCJ/GIJ ( 0930: 46 72 65 65 20 53 6f 66 74 77 61 72 65 20 46 6f Free Software Fo 0940: 75 6e 64 61 74 69 6f 6e 29 0a 09 20 20 20 20 2a undation).. * 0950: 20 4a 61 6d 56 4d 20 28 52 6f 62 65 72 74 20 4c JamVM (Robert L 0960: 6f 75 67 68 65 72 29 0a 09 20 20 20 20 2a 20 4d ougher).. * M 0970: 69 63 72 6f 73 6f 66 74 20 4a 61 76 61 20 56 69 icrosoft Java Vi 0980: 72 74 75 61 6c 20 4d 61 63 68 69 6e 65 20 28 4d rtual Machine (M 0990: 69 63 72 6f 73 6f 66 74 29 0a 09 20 20 20 20 2a icrosoft).. * 09a0: 20 4d 69 63 72 6f 73 6f 66 74 20 2e 4e 45 54 20 Microsoft .NET 09b0: 28 4d 69 63 72 6f 73 6f 66 74 29 0a 09 20 20 20 (Microsoft).. 09c0: 20 2a 20 4d 6f 6e 6f 20 28 4d 69 63 72 6f 73 6f * Mono (Microso 09d0: 66 74 29 0a 09 20 20 20 20 2a 20 4f 70 65 6e 4a ft).. * OpenJ 09e0: 44 4b 20 28 53 75 6e 20 4d 69 63 72 6f 73 79 73 DK (Sun Microsys 09f0: 74 65 6d 73 2f 4f 72 61 63 6c 65 29 0a 09 20 20 tems/Oracle).. 0a00: 20 20 2a 20 50 68 6f 6e 65 4d 45 20 28 53 75 6e * PhoneME (Sun 0a10: 20 4d 69 63 72 6f 73 79 73 74 65 6d 73 2f 4f 72 Microsystems/Or 0a20: 61 63 6c 65 29 0a 09 20 33 2e 20 49 66 20 65 6d acle).. 3. If em 0a30: 70 6c 6f 79 65 64 20 62 79 20 61 20 63 6f 6d 70 ployed by a comp 0a40: 61 6e 79 2c 20 79 6f 75 20 68 61 76 65 20 61 20 any, you have a 0a50: 72 69 67 68 74 20 62 79 20 74 68 61 74 20 63 6f right by that co 0a60: 6d 70 61 6e 79 20 74 6f 20 70 72 6f 76 69 64 65 mpany to provide 0a70: 0a 09 20 20 20 20 63 6f 6e 74 72 69 62 75 74 69 .. contributi 0a80: 6f 6e 73 20 74 6f 20 74 68 69 73 20 70 72 6f 6a ons to this proj 0a90: 65 63 74 2e 0a 09 20 34 2e 20 48 61 76 65 20 70 ect... 4. Have p 0aa0: 6c 65 64 67 65 64 20 74 6f 20 66 6f 6c 6c 6f 77 ledged to follow 0ab0: 20 74 68 65 20 43 6f 64 65 20 6f 66 20 43 6f 6e the Code of Con 0ac0: 64 75 63 74 2e 0a 0a duct...