TrustedUser
574
edits
Difference between revisions of "Developer Central"
→Getting started: Update for Git/Github workflow.
Dreammaster (talk | contribs) m (Added new link for the Reverse Engineering HOWTO) |
(→Getting started: Update for Git/Github workflow.) |
||
| Line 8: | Line 8: | ||
* Some hints on [[Debugging ScummVM|debugging ScummVM]]. | * Some hints on [[Debugging ScummVM|debugging ScummVM]]. | ||
* Before you write/submit code, '''you must read | * Before you write/submit code, '''you must read''' 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]]. | * Also, you should read and respect the general [[Coding Conventions]]. | ||
* If you have write access to our repository, you are expected to have read and to comply with our [[Commit Guidelines]]. Also, read | * 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 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 access, you should | * If you do not have write (push) access to our repository, you should submit your contributions by one of the following methods: | ||
** Using a [https://help.github.com/articles/using-pull-requests 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 [http://sourceforge.net/tracker/?group_id=37116&atid=418822 patch tracker].<br>This requires you to have/register a sourceforge.net account, and generate a [https://en.wikipedia.org/wiki/Patch_%28Unix%29 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 accept 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 [http://doxygen.scummvm.org/ Doxygen source code documentation] may help you to get the big picture about ScummVM. | * Our [http://doxygen.scummvm.org/ 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]]. | * Also, you might want to check our list for current [[Platform Limitations]]. | ||