antz

So you've found a bug you want to fix, or a feature you want to implement, thanks! If you follow this guide it will make it much easier for the community to review your changes, and the core team to get them included in the next release. If you need an introduction to git, check out the tutorial and Everyday GIT With 20 Commands Or So. Making Your Changes The first thing you need to do is obtain a clone of the MaNGOS repository (We will assume MangosZero in these examples) $ git clone --recursive http://github.com/mangoszero/server.git 0server $ cd 0server Then you need to create your new branch: $ git checkout -b make_mangos_scale Switched to a new branch "make_mangos_scale" Now you're ready to get coding. Be sure to include tests which demonstrate the bug you're fixing, and fully exercise any new features you're adding. You should also take care to make sure the documentation is updated if you're changing the API. Once you've finished making your changes you need to commit them. $ git commit -a -m "I made MaNGOS scale by adding quantum tunneling" Created commit 29f8baa: I made MaNGOS scale by adding quantum tunneling 1 files changed, 0 insertions(+), 1 deletions(-) Preparing your changes for submission. Now that you've made your changes it's time to get them into a patch. We need to update rails and fix any conflicts we had. $ git checkout master Switched to branch "master" $ git pull $ git submodule init $ git submodule update ... $ git checkout make_mangos_scale Switched to branch "make_mangos_scale" $ git rebase master Once you've fixed any conflicts, you're ready to create a patch: $ git format-patch master --stdout > make-mangos-scale.diff Now you can attach that patch file to a getmangos.eu tracker ticket and add the 'patch' tag. Reviewing Changes To apply someone's changes you need to first create a branch: $ git checkout -b koz_made_mangos_scale Then you can apply their patch $ git am < their-patch-file.diff Once you have a working copy, you should take note of the following kinds of things: Are you happy with the tests, can you follow what they're testing, is there anything missing Does the documentation still seem right to you Do you like the implementation, can you think of a nicer or faster way to implement a part of their change Once you're happy it's a good change, please comment on the ticket indicating your approval. Your comment should indicate that you like the change and what you like about it. Something like: I like the way you've restructured that code in Server namespace, much nicer. The tests look good too. If your comment simply says +1, then odds are other reviewers aren't going to take it too seriously. Show that you took the time to review the patch. Once three people have approved it, add the verified tag. This will bring it to the attention of a committer who'll then review the changes looking for the same kinds of things. Congratulations and Thank You! Once your changes have been applied, you've officially become part of the large community of independent contributors working to improve MaNGOS. Important Notes The MaNGOS core team prefers that you create a github fork only for large changesets which are likely to involve a lot of code reviews/changes back and forth, or if 2 or more people are working on the same feature/bug. But of course, like all the rules, exceptions can be made for cases that demands for it.

The Year in Review 2014 What follows is a quick summary of 2014, plus how we did against the Roadmap set out for the year. MaNGOS had a difficult year with whole chunks of bugs being reported for the first time. While some of these bugs were new, a majority were bugs that have been there for years. Part of the reason they have only just started to be reported and Two-fold. 1) The Unified Tracker on the website has helped bring this issues to light easier, plus the ability to raise a log from a forum post. 2) With the massively improved Build System in Mangos Zero, people are able to build and use mangos with the minimum of hassle. Having some of the Eluna team onboard also helped to get the Eluna implementation completed a lot smoother than we would have done otherwise. How did we do on our Goals for 2014 Continued alignment of the cores. Different teams did things slightly differently and as a result we have similar functions in different cores using different names. This need tidying up The Rel20 branches have all received extensive syncronisation / cleanup and this work in ongoing. For example, a git diff between MangosZero and MangosOne before the sync came in at over 80mb, run a diff now and it's about 12mb. There is still work continueing, but it's work in the right direction. Documenting the core, other groups shy away from this work as they feel it is beneath them. We are an educational group, documenting the core we help others learn. Again, this is ongoing. As our devs are working on different parts of the system and making changes, they are adding documentation. Also the DBDocs project has helped to document the database significantly better than any other Emu project, this too is ongoing. To this end, tools have been written to allow users to help update the information. Continue to look at new ways to improve mangos, both from a technical aspect as well as a functional one. Rel20 introduced git submodules - where common code is shared among all projects. Eluna, Realmd, the Deps all benefitted from this change and applied Across Zero, One and Two and to a lesser degree Three. The new SD3 project, which will replace the different SD2 modules in all the cores in Rel21 is a continuation of this work. SD3 is a single scripting library which is compatible with all the cores, rather than five slightly different libraries. This has been made possible thanks to the groundwork laid down by the Eluna team in their efforts to allow a single Eluna Library to work with all the cores. Developing better code, remove hardcoded values. historically developers never believed things would never change and hardcoded a lot of values in various areas of the core. This makes extending quite complex in places. Sadly this is still outstanding, due to the amount of work syncing the cores up. This should happen soon Some of the database has been designed badly (playerbytes anyone), we intend to review and enhance the database where we can to improve performance and readability. Some work has been done on how this can be achieved, nothing has been completed - but there are several changes that are currently WIP. More improvement to the server files to make them consistent across the cores. Rel20 of Zero, One and Two offer a very consistant project structure and build process - This will continue Continue our commitment to the Eluna project and add LUA support across the cores. As of Rel20, Eluna is now present in Zero, One and Two. Work is in progress to get it implemented in Three and Four Lastly, helping to teach more people for the core and scripting libraries work. This year has seen an influx of new devs and sorely needed scriptors / db devs. The improvement of the information held in the Wiki, plus fixing any highlighted shortfalls has pushed this effort on a long way. Things the devs wanted to improve: The devs were asked: "If you wanted two things to put on the 'roadmap' for mangos for the coming year, what would they be ?" Look at streamlining the installation and upgrade process, in particular database upgrades Work has already been done on this, but it's not complete yet. The numbering system has been simplifier significantly. With the reorg of the project files, all DB updates are now in a single repo To help with debugging, there is now an update history stored in the db_revision table. Look at the concept of scripting things like spells, NPCs etc; there's no reason why a basic quest scripts should be a dozen lines long when the same thing could be done in a line or two in something like Lua or JavaScript. There is work ongoing with a redesign of the spell system. Have a clear view of what's working good, what needs work, what is broken ... also in terms of content (which instances work) that would be useful. The Tracker has been a huge boost, plus using stats fed back from the cove servers have helped Reorganise the project file system to all mangos branches and backport the Cryptography and Implemention as used in other projects. That way development can continue on Warden. A majority of the project files have been reorganised and synced up and the differing Realm projects merged to become a single project. We need some core cleanup perhaps, As in getting the core documented etc. Work is ongoing on this, but a lot of progress has been made This has been done or is ongoing DK rune system rewrite New virtual functions in scripts Full mingw support Creature_difficulty system rewrite. Still outstanding Dungeon finder Some work has already been done for this in Two.

MaNGOS is still in a transition period while we continue to move from the old build to a new more redefined method. - The method used in MaNGOS Zero was not 100% successful, work is continuing to revise and improve the windows experience from this. Goals for 2014 Continued alignment of the cores. Different teams did things slightly differently and as a result we have similar functions in different cores using different names. This need tidying up Documenting the core, other groups shy away from this work as they feel it is beneath them. We are an educational group, documenting the core we help others learn. Continue to look at new ways to improve mangos, both from a technical aspect as well as a functional one. Developing better code, remove hardcoded values. Sadly some of our older developers never believed things would never change and hardcoded a lot of values in various areas of the core. This makes extending quite complex in places. Some of the database has been designed badly (playerbytes anyone), we intend to review and enhance the database where we can to improve performance and readability. More improvement to the server files to make them consistent across the cores. Continue our commitment to the Eluna project and add LUA support across the cores. Lastly, helping to teach more people for the core and scripting libraries work. We also recently asked our devs a question: "If you wanted two things to put on the 'roadmap' for mangos for the coming year, what would they be ?" Look at streamlining the installation and upgrade process, in particular database upgrades Look at the concept of scripting things like spells, NPCs etc; there's no reason why a basic quest scripts should be a dozen lines long when the same thing could be done in a line or two in something like Lua or JavaScript. Have a clear view of what's working good, what needs work, what is broken ... also in terms of content (which instances work) that would be useful. Reorganise the project file system to all mangos branches and backport the Cryptography and Implemention as used in other projects. That way development can continue on Warden. We need some core cleanup perhaps, As in getting the core documented etc. DK rune system rewrite New virtual functions in scripts Full mingw support Creature_difficulty system rewrite. Dungeon finder