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*** (later: 1.12), ***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 subgame,
  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
  30 * Ask me to pull in your changes (and briefly say what you're changed)
  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 ## Quality remarks
  38 Again: There is ***no*** guarantee I will accept anything from anything.
  39 But I will gladly take in code from others when I feel it saves me work
  40 in the long run.
  41
  42 ### Inclusion criteria
  43 Depending on what you add, the chances for inclusion vary:
  44
  45 ### High chance for inclusion
  46 * Gameplay features in Minecraft which are missing in MineClone 2
  47
  48 ### Medium chance for inclusion (discuss first)
  49 * Features which don't a impact on gameplay
  50 * GUI improvement
  51 * Features from pocket or console edition
  52
  53 ### Low chance for inclusion (discuss/optimize first)
  54 * Overhaul of architecture / mod structure
  55 * Mass-itemstring changes all over the place
  56 * Added files have a unusual high file size
  57 * Indentation looks like crazy
  58 * Single commits which add several unrelated things
  59
  60 ### Instant rejection
  61 * Gameplay features which don't exist in Minecraft
  62 * Proprietary **anything**
  63 * Code contains `minetest.env` anywhere
  64
  65 ## Coding style guide
  66 * Indentations should reflect the code flow
  67 * Use tabs, not spaces for indentation
  68 * Never use `minetest.env`
  69
  70 ## Reporting bugs
  71 Report all bugs and missing Minecraft features here:
  72
  73 <https://github.com/Wuzzy2/MineClone2-Bugs>