TYPO3 Code Review

Ärgerlich. Da gibt es einen Bug
Was nun?
Projekt steht ...
TYPO3 Code Review


Bugtracker: forge.typo3.org



Nichts gefunden? „New Issue“



Bug existiert: Nächstes Slide
„New Issue“

Genaue Beschreibung, Reproduzierbarkeit,
TYPO3/PHP Version, Kategorie, Screenshots
TYPO3 Code Review
Bei vielen Bugs gibt es schon fertige Patches


Bug wird gemeldet



Patch wird auf Review-Server geschickt



Verschiedene Personen machen ein Review



Patch +2/+2: Wird gemerged und landet in
„Upstream“. Fertig.
TYPO3 Code Review
Problem: Für noch mehr viele Patches gibt es
keine Reviews :(


Bug ist also schon im Bugtracker eingetragen



Link auf Review Server (gerrit) folgen



Lokalen TYPO3 source patchen



Keinen lokalen Source? GIT
TYPO3 Code Review


TYPO3 master aus GIT beziehen:
cd /home/kraftb/src/
git clone git://git.typo3.org/Packages/TYPO3.CMS.git



GIT Cheatsheet:

http://www.ndpsoftware.com/git-cheatsheet.html


Buch „Pro Git“:
http://git-scm.com/book
TYPO3 Code Review


Patch von gerrit auf lokalen Souce anwenden:
cd TYPO3.CMS
git fetch git://git.typo3.org/Packages/TYPO3.CMS
refs/changes/39/25839/2 && git cherry-pick FETCH_HEAD
TYPO3 Code Review
Testen


Funktioniert alles wie gewohnt



Ist der Fehler behoben



Gibt es sonstige Probleme



So gut als möglich testen z.B. während der
Entwicklung einer Site, evtl. sogar im Live
Betrieb
TYPO3 Code Review
Code Review





Gibt es offensichtliche Fehler im Code
Ist der Code gut dokumentiert und
verständlich
Entspricht er den Coding Guidelines?

http://docs.typo3.org/TYPO3/CodingGuidelinesReference/
TYPO3 Code Review
Review abgeben


Für login auf review.typo3.org ist typo3.org
Account notwendig



Button „Add comment“ ganz am Ende



Beschreiben was und wie getestet wurde



Probleme?





Verified: +1 ... Problem behoben und alles
funktioniert nach wie vor wie erwartet
Code Review. +1 ... Code ist lesbar und
scheint kein offensichtliches Problem zu
(c) 2013 kraft@webconsulting.at

TYPO3 Code Review Process

  • 1.
    TYPO3 Code Review Ärgerlich.Da gibt es einen Bug Was nun? Projekt steht ...
  • 3.
    TYPO3 Code Review  Bugtracker:forge.typo3.org  Nichts gefunden? „New Issue“  Bug existiert: Nächstes Slide „New Issue“ Genaue Beschreibung, Reproduzierbarkeit, TYPO3/PHP Version, Kategorie, Screenshots
  • 4.
    TYPO3 Code Review Beivielen Bugs gibt es schon fertige Patches  Bug wird gemeldet  Patch wird auf Review-Server geschickt  Verschiedene Personen machen ein Review  Patch +2/+2: Wird gemerged und landet in „Upstream“. Fertig.
  • 5.
    TYPO3 Code Review Problem:Für noch mehr viele Patches gibt es keine Reviews :(  Bug ist also schon im Bugtracker eingetragen  Link auf Review Server (gerrit) folgen  Lokalen TYPO3 source patchen  Keinen lokalen Source? GIT
  • 6.
    TYPO3 Code Review  TYPO3master aus GIT beziehen: cd /home/kraftb/src/ git clone git://git.typo3.org/Packages/TYPO3.CMS.git  GIT Cheatsheet: http://www.ndpsoftware.com/git-cheatsheet.html  Buch „Pro Git“: http://git-scm.com/book
  • 8.
    TYPO3 Code Review  Patchvon gerrit auf lokalen Souce anwenden: cd TYPO3.CMS git fetch git://git.typo3.org/Packages/TYPO3.CMS refs/changes/39/25839/2 && git cherry-pick FETCH_HEAD
  • 10.
    TYPO3 Code Review Testen  Funktioniertalles wie gewohnt  Ist der Fehler behoben  Gibt es sonstige Probleme  So gut als möglich testen z.B. während der Entwicklung einer Site, evtl. sogar im Live Betrieb
  • 11.
    TYPO3 Code Review CodeReview    Gibt es offensichtliche Fehler im Code Ist der Code gut dokumentiert und verständlich Entspricht er den Coding Guidelines? http://docs.typo3.org/TYPO3/CodingGuidelinesReference/
  • 12.
    TYPO3 Code Review Reviewabgeben  Für login auf review.typo3.org ist typo3.org Account notwendig  Button „Add comment“ ganz am Ende  Beschreiben was und wie getestet wurde  Probleme?   Verified: +1 ... Problem behoben und alles funktioniert nach wie vor wie erwartet Code Review. +1 ... Code ist lesbar und scheint kein offensichtliches Problem zu
  • 13.