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 * Post a pull request here: https://git.minetest.land/Wuzzy/MineClone2/pulls
  30 * Alternatively: Upload the repository somewhere where it can be accessed
  31   from the Internet and notify me
  32
  33 For small changes, sending me a patch is also good.
  34
  35 For big changes: Same as above, but consider notifying me first to avoid
  36 duplicate work and possible tears of rejection. ;-)
  37
  38 ## Quality remarks
  39 Again: There is ***no*** guarantee I will accept anything from anybody.
  40 But I will gladly take in code from others when I feel it saves me work
  41 in the long run.
  42
  43 ### Inclusion criteria
  44 Depending on what you add, the chances for inclusion vary:
  45
  46 ### High chance for inclusion
  47 * Gameplay features in Minecraft which are missing in MineClone 2
  48
  49 ### Medium chance for inclusion (discuss first)
  50 * Features which don't a impact on gameplay
  51 * GUI improvement
  52 * Features from pocket or console edition
  53
  54 ### Low chance for inclusion (discuss/optimize first)
  55 * Overhaul of architecture / mod structure
  56 * Mass-itemstring changes all over the place
  57 * Added files have a unusual high file size
  58 * Indentation looks like crazy
  59 * Single commits which add several unrelated things
  60
  61 ### Instant rejection
  62 * Gameplay features which don't exist in Minecraft
  63 * Proprietary **anything**
  64 * Code contains `minetest.env` anywhere
  65
  66 ## Coding style guide
  67 * Indentations should reflect the code flow
  68 * Use tabs, not spaces for indentation (tab size = 8)
  69 * Never use `minetest.env`
  70
  71 ## Reporting bugs
  72 Report all bugs and missing Minecraft features here:
  73
  74 <https://git.minetest.land/Wuzzy/MineClone2/issues>