tools.jpg

Deze beknopte handleiding is voor iedereen die wil helpen met het verbeteren van de Joomla-software. Alle software bevat kleine fouten ("bugs") en Joomla is geen uitzondering.


Om dergelijke bugs te verhelpen worden kleine verbeteringen ("Patches") gemaakt. Dergelijke "pleisters" moeten eerst worden getest voordat deze verbeteringen kunnen worden toegevoegd aan de Joomla broncode. Voor testen zijn geen diepgaande technische vaardigheden nodig: Iedereen enige Joomla ervaring kan helpen met het testen van bugs en patches!

Deze beknopte handleiding beschrijft de Joomla Issue Tracker, Hoe je een Joomla testomgeving kunt opzetten, hoe een patch te testen, hoe je een bug report maakt en hoe je een patch kunt aandragen.

Download:

pdfJoomla Bugs & Patches - Quick Reference Guide

Joomla Bugs & Patches - Quick Reference Guide

Joomla Issue Tracker

  • http://issues.joomla.org/
  • Login with Github account -> no account? https://github.com/
  • Status: New > Confirmed > Pending > Ready to Commit (RTC) > Closed
    • New - Just reported

    •  

      Confirmed - Someone reproduced & confirmed error
    • Pending - Patch available (“PR” - pull request); needs 2 successful tests
    • Ready To Commit - To be added to Joomla source code
    • Needs Review - Need experienced developer to review the issue
    • Information Required - Need more info from the person who reported the issue

Testing Bugs, Reports, Patches

  • Have working local web server environment (XAMPP, MAMP ect)
  • Get Joomla “staging” from: https://github.com/joomla/joomla-cms
    • Download, unzip to folder 
      or:
      git clone https://github.com/joomla/joomla-cms.git
  • Install Joomla at local web server
    • Install with: Test English (GB) sample data
    • Do not remove /installation/ folder!>
  • Joomla Patch Tester Component
  • Testing found issues
    • Find issue in Joomla Issue Tracker (useful filters: status, category, tests, easy)
    • Reproduce bug (can't reproduce bug? → report)
    • Install Patch in Joomla Patch Tester Component
    • patch: [#ID of patch – Some descriptive title for problem/patch]
    • Test if bug is solved & report findings (use @test for successful test)
    • Remove Patch (“revert patch”)

    Report Bug

    • Search in Issue Tracker if issue has been reported already
    • Create new item [New Item]
      • Title: use descriptive title!
      • Description:
        • Steps to reproduce the issue
        • Expected result & actual result
        • System information (as much as possible)
          e.g. your PHP information, browser + version
        • Additional comments
      • Priority: default: Medium
      • Build: 3.4.0-dev (at this moment)
      • Categories: select the most appropriate categories

    Create Patch

    Patch = text file that describes changes in source code.
    Methods:

    • Use IDE (like Netbeans, PHPStorm)
      • Improve Joomla code in editor & create .diff patch
    • Use Github: https://github.com/joomla/joomla-cms
      • Navigate to page with code
      • Click “pencil” icon: “Clicking this button will fork this project so you can edit the file”
      • Add improvements:
        • Make changes in code under “Edit file”
        • Add Commit Summary under Propose file change (50 char or less)
        • Use optional extended description (in case 50 char was not enough)
      • Save & choose Pull Request
    • Use Command line “git” (for experienced users)

    More info:

    Bug Squad: http://docs.joomla.org/Bug_Squad
    Bug Tracking Process: http://docs.joomla.org/Bug_Tracking_Process
    Testing Checklist: http://docs.joomla.org/Testing_Checklists