CONTRIBUTING.md

   1 # Contributing to MineClone 2
   2 So you want to MineClone 2?
   3 Wow, thank you! :-)
   4
   5 But first, some things to note:
   6
   7 MineClone 2's development target is to make a free software clone of Minecraft,
   8 ***version 1.11***, ***PC edition***.
   9
  10 MineClone 2 is maintained by one person. Namely, Wuzzy. You can find me,
  11 Wuzzy, in the Minetest forums (forums.minetest.net), in IRC in the #minetest
  12 channel on irc.freenode.net. And finally, you can send e-mails to
  13 <Wuzzy2@mail.ru>.
  14
  15 There is **no** guarantee I will accept anything from anybody.
  16
  17 By sending me patches or asking me to include your changes in this game,
  18 you agree that they fall under the terms of the LGPLv2.1, which basically
  19 means they will become part of a free software.
  20
  21 ## The suggested workflow
  22 I don't **dictate** your workflow, but in order to work with me in an efficient
  23 way, you can follow my suggestions.
  24
  25 For small and medium changes:
  26
  27 * Fork the repository
  28 * Do your change in a new branch
  29 * Upload the repository somewhere where it can be accessed from the Internet and
  30   notify me
  31
  32 For small changes, sending me a patch is also good.
  33
  34 For big changes: Same as above, but consider notifying me first to avoid
  35 duplicate work and possible tears of rejection. ;-)
  36
  37 For people that I trust, I might give them direct commit access to this
  38 repository. In this case, you obviously don't need to fork, but you still
  39 need to show your contributions align with the project goals. I still
  40 reserve the right to revert everything that I don't like.
  41 For bigger changes, I strongly recommend to use feature branches and
  42 discuss with me first.
  43
  44 Contributors will be credited in `README.md`.
  45
  46 ## Quality remarks
  47 Again: There is ***no*** guarantee I will accept anything from anybody.
  48 But I will gladly take in code from others when I feel it saves me work
  49 in the long run.
  50
  51 ### Inclusion criteria
  52 Depending on what you add, the chances for inclusion vary:
  53
  54 ### High chance for inclusion
  55 * Gameplay features in Minecraft which are missing in MineClone 2
  56
  57 ### Medium chance for inclusion (discuss first)
  58 * Features which don't a impact on gameplay
  59 * GUI improvement
  60 * Features from pocket or console edition
  61
  62 ### Low chance for inclusion (discuss/optimize first)
  63 * Overhaul of architecture / mod structure
  64 * Mass-itemstring changes all over the place
  65 * Added files have a unusual high file size
  66 * Indentation looks like crazy
  67 * Single commits which add several unrelated things
  68 * Gameplay features which don't exist in Minecraft
  69
  70 ### Instant rejection
  71 * Proprietary **anything**
  72 * Code contains `minetest.env` anywhere
  73
  74 ## Coding style guide
  75 * Indentations should reflect the code flow
  76 * Use tabs, not spaces for indentation (tab size = 8)
  77 * Never use `minetest.env`
  78
  79 ## Reporting bugs
  80 Report all bugs and missing Minecraft features here:
  81
  82 <https://git.minetest.land/Wuzzy/MineClone2/issues>
  83
  84 ## Direct discussion
  85 We have an IRC channel! Join us on #mineclone2 in freenode.net.
  86
  87 <ircs://irc.freenode.net:6697/#mineclone2>