Difference between revisions of "Testing Joomla! patches QuickReferenceGuide"

Latest revision as of 09:40, 10 July 2023

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]

https://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 and confirmed error
- Pending - Patch available (“PR” - pull request); needs two 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
- 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/releases
- 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[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 characters or less)
  - Use optional extended description (in case 50 characters was not enough)
- Save & choose Pull Request
Use Command line “git” (for experienced users)

More information[edit]

Component Patchtester: Component Patchtester for Testers
Testing Joomla! patches: Testing Joomla! patches
Testing Checklist: Testing Checklists
Filing bugs and issues: Filing bugs and issues
Bug Squad: Bug Squad
Bug Tracking Process: Bug Tracking Process

@@ Line 7: / Line 7: @@
 <translate>
-=== Joomla Issue Tracker ===  <!--T:2-->
+=== Joomla Issue Tracker === <!--T:2-->
-* http://issues.joomla.org/
+* https://issues.joomla.org/
 * Login with Github account -> no account? https://github.com/
-* Status: New > Confirmed > Pending > Ready to Commit (RTC) > Closed
+* Status: {{rarr|New,Confirmed,Pending,Ready to Commit (RTC),Closed}}
 ** '''New''' - Just reported
-** '''Confirmed''' - Someone reproduced & confirmed error
+** '''Confirmed''' - Someone reproduced and confirmed error
-** '''Pending''' - Patch available (“PR” - pull request); needs 2 successful tests
+** '''Pending''' - Patch available (“PR” - pull request); needs two successful tests
 ** '''Ready To Commit''' - To be added to Joomla source code
 ** Needs Review - Need experienced developer to review the issue
@@ Line 20: / Line 20: @@
 <translate>
-===Testing Bugs, Reports, Patches===
+===Testing Bugs, Reports, Patches=== <!--T:4-->
 * Have working local web server environment (XAMPP, MAMP ect)
 * Get Joomla “staging” from: https://github.com/joomla/joomla-cms
@@ Line 29: / Line 29: @@
 ** Do '''not remove''' /installation/ folder!
 * Joomla Patch Tester Component
-** Download from: https://github.com/joomla-extensions/patchtester
+** Download from: https://github.com/joomla-extensions/patchtester/releases
 ** Installation via Extensions > Install
 ** Add your own Github account details under Options (Username + Password)
@@ Line 41: / Line 41: @@
 <translate>
-===Report Bug===
+===Report Bug=== <!--T:5-->
 * Search in Issue Tracker if issue has been reported already
 * Create new item [New Item]
@@ Line 51: / Line 51: @@
 *** Additional comments
 ** Priority: default: Medium
-** Build: 3.3.7-dev (at this moment)
+** Build: 3.4.x-dev (at this moment)
 ** Categories: select the most appropriate categories
 </translate>
 <translate>
-===Create Patch===
+===Create Patch=== <!--T:6-->
 Patch = text file that describes changes in source code.
 </translate>
 <translate>
+<!--T:7-->
 Methods:
 * Use IDE (like Netbeans, PHPStorm)
-** Improve Joomla code in editor & create .diff patch
+** Improve Joomla code in editor & create ''.diff'' patch
 * Use Github: https://github.com/joomla/joomla-cms
 ** Navigate to page with code
@@ Line 69: / Line 70: @@
 ** Add improvements:
 *** Make changes in code under “Edit file”
-*** Add Commit Summary under Propose file change (50 char or less)
+*** Add Commit Summary under Propose file change (50 characters or less)
-*** Use optional extended description (in case 50 char was not enough)
+*** Use optional extended description (in case 50 characters was not enough)
 ** Save & choose Pull Request
 * Use Command line “git” (for experienced users)
@@ Line 76: / Line 77: @@
 <translate>
-===More information===
+===More information=== <!--T:8-->
 * Component Patchtester: [[S:MyLanguage/Component Patchtester for Testers|Component Patchtester for Testers]]
 * Testing Joomla! patches: [[S:MyLanguage/Testing Joomla! patches|Testing Joomla! patches]]
@@ Line 85: / Line 86: @@
 </translate>
-<translate>
+<noinclude>
-<!--T:3-->
+[[Category:Bug Tracker{{#translation:}}]]
-[[Category:Bug Tracker]]
+[[Category:Bug Squad{{#translation:}}]]
-[[Category:Bug Squad]]
+[[Category:Tutorials{{#translation:}}]]
-</translate>
+</noinclude>