Testing Joomla! patches QuickReferenceGuide: Difference between revisions

From Joomla! Documentation

MATsxm (talk | contribs)
Added "more" links + marked for translation
MATsxm (talk | contribs)
Marked this version for translation
Line 7: Line 7:


<translate>
<translate>
=== Joomla Issue Tracker === <!--T:2-->
=== Joomla Issue Tracker === <!--T:2-->
* http://issues.joomla.org/
* http://issues.joomla.org/
* Login with Github account -> no account? https://github.com/
* Login with Github account -> no account? https://github.com/
Line 20: Line 20:


<translate>
<translate>
===Testing Bugs, Reports, Patches===
===Testing Bugs, Reports, Patches=== <!--T:4-->
* Have working local web server environment (XAMPP, MAMP ect)
* Have working local web server environment (XAMPP, MAMP ect)
* Get Joomla “staging” from: https://github.com/joomla/joomla-cms   
* Get Joomla “staging” from: https://github.com/joomla/joomla-cms   
Line 41: Line 41:


<translate>
<translate>
===Report Bug===
===Report Bug=== <!--T:5-->
* Search in Issue Tracker if issue has been reported already
* Search in Issue Tracker if issue has been reported already
* Create new item [New Item]
* Create new item [New Item]
Line 56: Line 56:


<translate>
<translate>
===Create Patch===
===Create Patch=== <!--T:6-->
Patch = text file that describes changes in source code.
Patch = text file that describes changes in source code.
</translate>
</translate>


<translate>
<translate>
<!--T:7-->
Methods:
Methods:
* Use IDE (like Netbeans, PHPStorm)
* Use IDE (like Netbeans, PHPStorm)
Line 76: Line 77:


<translate>
<translate>
===More information===
===More information=== <!--T:8-->
* Component Patchtester: [[S:MyLanguage/Component Patchtester for Testers|Component Patchtester for Testers]]
* Component Patchtester: [[S:MyLanguage/Component Patchtester for Testers|Component Patchtester for Testers]]
* Testing Joomla! patches: [[S:MyLanguage/Testing Joomla! patches|Testing Joomla! patches]]
* Testing Joomla! patches: [[S:MyLanguage/Testing Joomla! patches|Testing Joomla! patches]]

Revision as of 14:02, 28 February 2015

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

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
  • 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.3.7-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 information