Jump to navigation Jump to search
1,119 bytes added ,  05:42, 7 November 2012
→‎Getting started: Update for Git/Github workflow.
* Some hints on [[Debugging ScummVM|debugging ScummVM]].
* Before you write/submit code, '''you must read about our''' our [[Code Formatting Conventions]]. <br>Patches which do not follow them will be rejected or at least delayed until they are cleaned up to comply to them.
* Also, you should read and respect the general [[Coding Conventions]].
* If you have write (push) access to our repository, you are expected to have read and to comply with our [[Commit Guidelines]]. <br>Also, please read up on the tips for using Git here: [[Git tips]].<br>In particular, note the use of feature branches, when working on refactoring or other large connected changes, rather than committing directly to scummvm/master.* If you do not have write (push) accessto our repository, you should use submit your contributions by one of the following methods:** Using a [ Github Pull Request].<br> This requires you to have/register a github account, fork our repository, commit your changes to a branch and then issue a Pull Request.<br>This is the current preferred method as it is easier for the team to review, discuss and amend prior to merging.** Using the [ patch tracker] .<br>This requires you to have/register a account, and generate a [ patch] file, but this may be easier for developers unfamilar with Git or for small single commit changes, where a Pull Request might be considered overkill.** If neither of the above methods are suitable, individual developers may be willing to submit your contributionsaccept patches or amended source files by other methods i.e. e-mail, but please ask in the project IRC channel or by e-mail before doing this.
* Our [ Doxygen source code documentation] may help you to get the big picture about ScummVM.
* Also, you might want to check our list for current [[Platform Limitations]].


Navigation menu