Testing Joomla! patches QuickReferenceGuide

From Joomla! Documentation

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎español • ‎français • ‎português do Brasil

The Testing Joomla! patches page describes the patch testing procedure. This document is a Quick Reference Guide with all necessary steps.

Joomla Issue Tracker[edit]

  • 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[edit]

  • Have working local web server environment (XAMPP, MAMP ect)
  • Get Joomla “staging” from: https://github.com/joomla/joomla-cms
  • 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[edit]

  • 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.x-dev (at this moment)
    • Categories: select the most appropriate categories


Create Patch[edit]

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 information[edit]