Difference between revisions of "Testing Joomla! patches QuickReferenceGuide/en"
From Joomla! Documentation
(Importing a new version from external source) |
(Updating to match new version of source page) |
||
(4 intermediate revisions by the same user not shown) | |||
Line 23: | Line 23: | ||
** Do '''not remove''' /installation/ folder! | ** Do '''not remove''' /installation/ folder! | ||
* Joomla Patch Tester Component | * 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 | ** Installation via Extensions > Install | ||
** Add your own Github account details under Options (Username + Password) | ** Add your own Github account details under Options (Username + Password) | ||
Line 32: | Line 32: | ||
** Test if bug is solved & report findings (use @test for successful test) | ** Test if bug is solved & report findings (use @test for successful test) | ||
** Remove Patch (“revert patch”) | ** Remove Patch (“revert patch”) | ||
+ | |||
===Report Bug=== | ===Report Bug=== | ||
Line 43: | Line 44: | ||
*** Additional comments | *** Additional comments | ||
** Priority: default: Medium | ** Priority: default: Medium | ||
− | ** Build: 3. | + | ** Build: 3.4.x-dev (at this moment) |
** Categories: select the most appropriate categories | ** Categories: select the most appropriate categories | ||
+ | |||
===Create Patch=== | ===Create Patch=== | ||
Line 70: | Line 72: | ||
* Bug Tracking Process: [[S:MyLanguage/Bug Tracking Process|Bug Tracking Process]] | * Bug Tracking Process: [[S:MyLanguage/Bug Tracking Process|Bug Tracking Process]] | ||
− | [[Category:Bug Tracker]] | + | <noinclude> |
− | [[Category:Bug Squad]] | + | [[Category:Bug Tracker{{#translation:}}]] |
+ | [[Category:Bug Squad{{#translation:}}]] | ||
+ | [[Category:Tutorials{{#translation:}}]] | ||
+ | </noinclude> |
Latest revision as of 20:22, 28 August 2017
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
- 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
- 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
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
- 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