Jump to content
  • We are looking for staff for the Wiki area!
    If interested please
    click here and select "Documentation Team"

  • Sign in to follow this  

    How to work on bugs


    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.

    Edited by antz

    Sign in to follow this  


    User Feedback

    Recommended Comments

    How to fix bugs? This one is easy!

    Take up knitting instead. :P

    Your sanity will thank you.

     

     

    Still, it's a well-written guide. I give it 10/10. ^_^

    • Like 2

    Share this comment


    Link to comment
    Share on other sites


    Create an account or sign in to comment

    You need to be a member in order to leave a comment

    Create an account

    Sign up for a new account in our community. It's easy!

    Register a new account

    Sign in

    Already have an account? Sign in here.

    Sign In Now

Contact Us

To contact us click here
You can also email us at [email protected]

Privacy Policy | Terms & Conditions

Repositories

The Link to the master list
of MaNGOS repositories:
Copyright © getMaNGOS. All rights Reserved.

This website is in no way associated with or endorsed by Blizzard Entertainment®
×