2017-02-12 21:02:50 +00:00
|
|
|
# Contributing to MineClone 2
|
|
|
|
|
So you want to MineClone 2?
|
|
|
|
|
Wow, thank you! :-)
|
|
|
|
|
|
|
|
|
|
But first, some things to note:
|
|
|
|
|
|
|
|
|
|
MineClone 2's development target is to make a free software clone of Minecraft,
|
2020-04-30 16:25:23 +00:00
|
|
|
***version 1.11***, ***PC edition***.
|
2017-02-12 21:02:50 +00:00
|
|
|
|
2021-01-30 18:51:55 +00:00
|
|
|
MineClone 2 is maintained by two persons. Namely, kay27 and EliasFleckenstein. You can find us
|
|
|
|
|
in the Minetest forums (forums.minetest.net), in IRC in the #minetest
|
2017-02-12 21:02:50 +00:00
|
|
|
channel on irc.freenode.net. And finally, you can send e-mails to
|
2021-01-30 18:51:55 +00:00
|
|
|
<eliasfleckenstein@web.de> or <kay27@bk.ru>.
|
2017-02-12 21:02:50 +00:00
|
|
|
|
2021-01-30 18:51:55 +00:00
|
|
|
There is **no** guarantee we will accept anything from anybody.
|
2017-02-12 21:02:50 +00:00
|
|
|
|
2021-01-30 18:51:55 +00:00
|
|
|
By sending us patches or asking us to include your changes in this game,
|
2017-02-12 21:02:50 +00:00
|
|
|
you agree that they fall under the terms of the LGPLv2.1, which basically
|
|
|
|
|
means they will become part of a free software.
|
|
|
|
|
|
|
|
|
|
## The suggested workflow
|
2021-01-30 18:51:55 +00:00
|
|
|
We don't **dictate** your workflow, but in order to work with us in an efficient
|
|
|
|
|
way, you can follow these suggestions:
|
2017-02-12 21:02:50 +00:00
|
|
|
|
|
|
|
|
For small and medium changes:
|
|
|
|
|
|
|
|
|
|
* Fork the repository
|
|
|
|
|
* Do your change in a new branch
|
2020-05-05 00:23:17 +00:00
|
|
|
* Upload the repository somewhere where it can be accessed from the Internet and
|
2021-01-30 18:51:55 +00:00
|
|
|
notify us
|
2017-02-12 21:02:50 +00:00
|
|
|
|
2021-01-30 18:51:55 +00:00
|
|
|
For small changes, sending us a patch is also good.
|
2017-02-12 21:02:50 +00:00
|
|
|
|
2021-01-30 18:51:55 +00:00
|
|
|
For big changes: Same as above, but consider notifying us first to avoid
|
2017-02-12 21:02:50 +00:00
|
|
|
duplicate work and possible tears of rejection. ;-)
|
|
|
|
|
|
2021-01-30 18:51:55 +00:00
|
|
|
For trusted people, we might give them direct commit access to this
|
2020-05-30 18:57:54 +00:00
|
|
|
repository. In this case, you obviously don't need to fork, but you still
|
2021-01-30 18:51:55 +00:00
|
|
|
need to show your contributions align with the project goals. We still
|
|
|
|
|
reserve the right to revert everything that we don't like.
|
|
|
|
|
For bigger changes, we strongly recommend to use feature branches and
|
2020-05-30 18:57:54 +00:00
|
|
|
discuss with me first.
|
|
|
|
|
|
|
|
|
|
Contributors will be credited in `README.md`.
|
|
|
|
|
|
2017-02-12 21:02:50 +00:00
|
|
|
## Quality remarks
|
2021-01-30 18:51:55 +00:00
|
|
|
Again: There is ***no*** guarantee we will accept anything from anybody.
|
|
|
|
|
But we will gladly take in code from others when we feel it saves us work
|
2017-02-12 21:02:50 +00:00
|
|
|
in the long run.
|
|
|
|
|
|
|
|
|
|
### Inclusion criteria
|
|
|
|
|
Depending on what you add, the chances for inclusion vary:
|
|
|
|
|
|
|
|
|
|
### High chance for inclusion
|
|
|
|
|
* Gameplay features in Minecraft which are missing in MineClone 2
|
|
|
|
|
|
|
|
|
|
### Medium chance for inclusion (discuss first)
|
|
|
|
|
* Features which don't a impact on gameplay
|
|
|
|
|
* GUI improvement
|
|
|
|
|
* Features from pocket or console edition
|
|
|
|
|
|
|
|
|
|
### Low chance for inclusion (discuss/optimize first)
|
|
|
|
|
* Overhaul of architecture / mod structure
|
|
|
|
|
* Mass-itemstring changes all over the place
|
|
|
|
|
* Added files have a unusual high file size
|
|
|
|
|
* Indentation looks like crazy
|
|
|
|
|
* Single commits which add several unrelated things
|
2020-05-30 18:57:54 +00:00
|
|
|
* Gameplay features which don't exist in Minecraft
|
2017-02-12 21:02:50 +00:00
|
|
|
|
|
|
|
|
### Instant rejection
|
|
|
|
|
* Proprietary **anything**
|
|
|
|
|
* Code contains `minetest.env` anywhere
|
|
|
|
|
|
|
|
|
|
## Coding style guide
|
|
|
|
|
* Indentations should reflect the code flow
|
2020-04-30 16:25:23 +00:00
|
|
|
* Use tabs, not spaces for indentation (tab size = 8)
|
2017-02-12 21:02:50 +00:00
|
|
|
* Never use `minetest.env`
|
|
|
|
|
|
2017-02-20 15:56:23 +00:00
|
|
|
## Reporting bugs
|
|
|
|
|
Report all bugs and missing Minecraft features here:
|
|
|
|
|
|
2021-01-30 20:50:54 +00:00
|
|
|
<https://git.minetest.land/MineClone2/MineClone2/issues>
|
2020-07-31 13:20:59 +00:00
|
|
|
|
|
|
|
|
## Direct discussion
|
|
|
|
|
We have an IRC channel! Join us on #mineclone2 in freenode.net.
|
|
|
|
|
|
|
|
|
|
<ircs://irc.freenode.net:6697/#mineclone2>
|
2021-01-26 16:21:05 +00:00
|
|
|
|
|
|
|
|
## Creating releases
|
|
|
|
|
* Launch MineClone2 to make sure it still runs
|
|
|
|
|
* Update the version number in README.md
|
|
|
|
|
* Use `git tag <version number>` to tag the latest commit with the version number
|
|
|
|
|
* Push to repo (don't forget `--tags`!)
|
|
|
|
|
* Update ContentDB (https://content.minetest.net/packages/Wuzzy/mineclone2/)
|
|
|
|
|
* Update first post in forum thread (https://forum.minetest.net/viewtopic.php?f=50&t=16407)
|
|
|
|
|
* Post release announcement and changelog in forums
|
