diff --git a/Compile.rst b/Compile.rst index 9a6d2f8a2..7e17ed453 100644 --- a/Compile.rst +++ b/Compile.rst @@ -286,48 +286,4 @@ Currently the supported set of requests is limited, because the developers don't Protocol client implementations exist for Java and C#. -Contributing to DFHack -====================== - -Several things should be kept in mind when contributing to DFHack. - ------------- -Coding style ------------- -DFhack uses ANSI formatting and four spaces as indentation. Line -endings are UNIX. The files use UTF-8 encoding. Code not following this -won't make me happy, because I'll have to fix it. There's a good chance -I'll make *you* fix it ;) - -------------------------------- -How to get new code into DFHack -------------------------------- -You can send patches or make a clone of the github repo and ask me on -the IRC channel to pull your code in. I'll review it and see if there -are any problems. I'll fix them if they are minor. - -Fixes are higher in priority. If you want to work on something, but -don't know what, check out http://github.com/DFHack/dfhack/issues -- -this is also a good place to dump new ideas and/or bugs that need -fixing. - ---------------- -Memory research ---------------- -If you want to do memory research, you'll need some tools and some knowledge. -In general, you'll need a good memory viewer and optionally something -to look at machine code without getting crazy :) - -Good windows tools include: - -* Cheat Engine -* IDA Pro 5.0 (freely available for non-commercial use) - -Good linux tools: - -* angavrilov's df-structures gui (visit us on IRC for details). -* edb (Evan's Debugger) -* IDA Pro 5.0 running under Wine -* Some of the tools residing in the ``legacy`` dfhack branch. - -Using publicly known information and analyzing the game's data is preferred. + diff --git a/Contribute.rst b/Contribute.rst new file mode 100644 index 000000000..7f55cd7b4 --- /dev/null +++ b/Contribute.rst @@ -0,0 +1,53 @@ +###################### +Contributing to DFHACK +###################### + +.. contents:: + +Contributing to DFHack +====================== + +Several things should be kept in mind when contributing to DFHack. + +--------------- +C++ code Format +--------------- + +* Four space indents +* LF (Unix style) line terminators +* UTF-8 encoding + +------------------------------- +How to get new code into DFHack +------------------------------- + +* Code against the develop branch +* Use new branches for each feature/fix +* If possible, compile on multiple platforms +* Do update NEWS/Contributors.rst +* Do **NOT** run fix-texts.sh or update .html files (unless to locally test changes to .rst files) +* Create a Github Pull Request once finished +* Work done against `issues `_ that are tagged "bug report" gets priority + + * If you have an idea or bug, go ahead and create an issue for it + +--------------- +Memory research +--------------- +If you want to do memory research, you'll need some tools and some knowledge. +In general, you'll need a good memory viewer and optionally something +to look at machine code without getting crazy :) + +Good windows tools include: + +* Cheat Engine +* IDA Pro 5.0 (freely available for non-commercial use) + +Good linux tools: + +* angavrilov's df-structures gui (visit us on IRC for details). +* edb (Evan's Debugger) +* IDA Pro 5.0 running under Wine +* Some of the tools residing in the ``legacy`` dfhack branch. + +Using publicly known information and analyzing the game's data is preferred. \ No newline at end of file