mirror of
https://git.minetest.land/MineClone2/MineClone2.git
synced 2024-08-19 21:44:12 +02:00
Add contributor's info
This commit is contained in:
parent
8fae394ee4
commit
b886e2bf32
69
CONTRIBUTING.md
Normal file
69
CONTRIBUTING.md
Normal file
@ -0,0 +1,69 @@
|
|||||||
|
# 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,
|
||||||
|
***version 1.11*** (later: 1.12), ***PC edition***.
|
||||||
|
|
||||||
|
MineClone 2 is maintained by one person. Namely, Wuzzy. You can find me,
|
||||||
|
Wuzzy, in the Minetest forums (forums.minetest.net), in IRC in the #minetest
|
||||||
|
channel on irc.freenode.net. And finally, you can send e-mails to
|
||||||
|
<Wuzzy2@mail.ru>.
|
||||||
|
|
||||||
|
There is **no** guarantee I will accept anything from anybody.
|
||||||
|
|
||||||
|
By sending me patches or asking me to include your changes in this subgame,
|
||||||
|
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
|
||||||
|
I don't **dictate** your workflow, but in order to work with me in an efficient
|
||||||
|
way, you can follow my suggestions.
|
||||||
|
|
||||||
|
For small and medium changes:
|
||||||
|
|
||||||
|
* Fork the repository
|
||||||
|
* Do your change in a new branch
|
||||||
|
* Upload the repository somewhere where it can be accessed from the Internet
|
||||||
|
* Ask me to pull in your changes (and briefly say what you're changed)
|
||||||
|
|
||||||
|
For small changes, sending me a patch is also good.
|
||||||
|
|
||||||
|
For big changes: Same as above, but consider notifying me first to avoid
|
||||||
|
duplicate work and possible tears of rejection. ;-)
|
||||||
|
|
||||||
|
## Quality remarks
|
||||||
|
Again: There is ***no*** guarantee I will accept anything from anything.
|
||||||
|
But I will gladly take in code from others when I feel it saves me work
|
||||||
|
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
|
||||||
|
|
||||||
|
### Instant rejection
|
||||||
|
* Gameplay features which don't exist in Minecraft
|
||||||
|
* Proprietary **anything**
|
||||||
|
* Code contains `minetest.env` anywhere
|
||||||
|
|
||||||
|
## Coding style guide
|
||||||
|
* Indentations should reflect the code flow
|
||||||
|
* Use tabs, not spaces for indentation
|
||||||
|
* Never use `minetest.env`
|
||||||
|
|
@ -142,6 +142,12 @@ core feature.
|
|||||||
Finally, any limitations found in Minetest (the game engine) will be written down in the course
|
Finally, any limitations found in Minetest (the game engine) will be written down in the course
|
||||||
of development.
|
of development.
|
||||||
|
|
||||||
|
## Other readme files
|
||||||
|
|
||||||
|
* `LICENSE.txt`: The LGPLv2.1 license text
|
||||||
|
* `CONTRIBUTING.md`: Information for those who want to contribute
|
||||||
|
* `MISSING_ENGINE_FEATURES.md`: List of missing features in Minetest which MineClone 2 would need for improvement
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
There are so many people to list (sorry).
|
There are so many people to list (sorry).
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user