This Quick Reference Guide is an overview for people who want to help out with improving the Joomla software.  All software contains small errors ("bugs") and Joomla is no exception.  

To solve these errors small improvements ("patches") are created and released. Such patches need to be tested before those improvements can be added to the Joomla source code. You don't need any programming skills to test: Anyone with some Joomla experience can help with testing bugs and patches!

This Quick Reference Guide describes the Joomla Issue Tracker, How to set up a test environment, How to test a patch, How to report a bug and how to submit a patch.

Download:

Joomla 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
  • Download from: https://github.com/joomla-extensions/patchtester
  • Installation via Extensions > Install
  • Add your own Github account details under Options (Username + Password)
• 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