Difference between revisions of "Bug Squad"
From Joomla! Documentation
m (Needs to be marked for translation) |
|||
| (82 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <noinclude><languages /></noinclude> | |
| − | <div style=" | + | <!-- This portal was created using subst:box portal skeleton --> |
| − | + | {{browsebar|bugsquad}}__NOTOC__ | |
| + | <div style="clear:both; width:100%"> | ||
| − | This is | + | {{:{{FULLPAGENAME}}/box-header|<big>This is the Joomla! Bug Squad Portal</big>|{{FULLPAGENAME}}/Intro|}} |
| − | [[ | + | {{{{FULLPAGENAME}}/Intro/<translate><!--T:2--> |
| + | en</translate>}} | ||
| + | {{:{{FULLPAGENAME}}/box-footer|Please make sure you read about the [[Bug Squad|Bug Squad]]}} | ||
</div> | </div> | ||
| + | <div class="portal-column-left"> | ||
| + | {{:{{FULLPAGENAME}}/box-header|Join the Bug Squad|{{FULLPAGENAME}}/Join the Bug Squad|}} | ||
| + | {{{{FULLPAGENAME}}/Join the Bug Squad}} | ||
| + | {{:{{FULLPAGENAME}}/box-footer|}} | ||
| + | </div> | ||
| + | <div class="portal-column-right"> <!-- Switch to one column on narrow screens --> | ||
| + | {{:{{FULLPAGENAME}}/box-header|Joomla! Bug Squad Communication|{{FULLPAGENAME}}/Communication|}} | ||
| + | {{{{FULLPAGENAME}}/Communication}} | ||
| + | {{:{{FULLPAGENAME}}/box-footer|}} | ||
| + | </div> | ||
| + | <div style="clear:both; width:100%"></div> | ||
| + | <div class="portal-column-right"> | ||
| + | {{:{{FULLPAGENAME}}/box-header|Manuals|{{FULLPAGENAME}}/Manuals|}} | ||
| + | {{{{FULLPAGENAME}}/Manuals}} | ||
| + | {{:{{FULLPAGENAME}}/box-footer|}} | ||
| − | + | {{:{{FULLPAGENAME}}/box-header|Setting Up Resources|{{FULLPAGENAME}}/Setting Up Resources|}} | |
| − | <div | + | {{{{FULLPAGENAME}}/Setting Up Resources/<translate><!--T:1--> |
| − | + | en</translate>}} | |
| − | + | {{:{{FULLPAGENAME}}/box-footer|}} | |
| − | + | </div> | |
| − | + | <div class="portal-column-left"> | |
| − | + | {{:{{FULLPAGENAME}}/box-header|Useful Information|{{FULLPAGENAME}}/Useful Information|}} | |
| + | {{{{FULLPAGENAME}}/Useful Information/<translate><!--T:3--> | ||
| + | en</translate>}} | ||
| + | {{:{{FULLPAGENAME}}/box-footer|<small>''...more [[:Category:Bug Squad|Bug Squad References]]''</small>}} | ||
| + | </div> | ||
| + | <div style="clear:both; width:100%"> | ||
| + | {{purgepage}}</div> | ||
| + | __NOTOC__ __NOEDITSECTION__ | ||
| − | + | <noinclude> | |
| − | </ | + | [[Category:Bug Squad|Bug Squad]] |
| + | [[Category:Development]] | ||
| + | [[Category:Needs to be marked for translation]] | ||
| + | </noinclude> | ||
Revision as of 09:04, 30 May 2015
JBS Portal Page · Bug Squad · Tracker Team · Coding Team · Automated Testing Team
Purpose
The purpose of the Joomla! Bug Squad (JBS) is to reduce the number of bugs in Joomla.
This is valid not only for the CMS, but for every Joomla (sub-)project.
Function
The Joomla! Bug Squad reduces the number of bugs in Joomla by following these approaches:
1. Scan the Forum[1], Mailing Lists[2], Social Media[3], Stack Overflow[4], and other external resources for reported issues.
It is not up to the JBS to provide support on those channels (although it would be appreciated), but to
- identify and confirm possible bugs,
- assist the poster to create an issue ticket on the tracker
- create an issue ticket on the tracker, if the poster is not able to do that
- leave a reference to the tracker item on the channel
The sooner this happens after the original post, the better the overall perception will be.
The main tool - and thus the single point of truth - is the issue tracker, which again is a customised view on several GitHub repositories. All relevant information from the channels mentioned above are consolidated here.
2. Confirm bugs using a test[5].
Ideally, a bug is confirmed when - and only when - a test exists that reproduces the issue. That test will prove the validity of any fix.
This is not possible in full extent currently. The JBS will work closely with the Automated Testing Team to provide a library of test functions that will allow non-coders to provide a test description that can be turned into test code (calls) automatically[6].
Until that library exists, manual confirmation is conducted.
In conjunction with the confirmation, JBS also makes sure each issue has the correct Type, Severity, and Priority.
3. Fix bugs
The first approach should always be to get the original development team of the buggy feature to fix the issue - they know so much more about the feature's domain than a JBS member can. JBS will help them if needed with implementing tests[7].
If the development team can't take over, a fix will be provided by JBS contributors.
4. Follow up issues
Whenever an issue gets stuck, JBS leadership will investigate the reasons and put the issue on track again.
5. Testing patches
Currently, two positive explorative tests are needed to accept a patch. JBS will support the Automated Testing Team in creating a Docker based test environment that allows to run the test suites on different web servers, with different databases, different PHP versions, and so on. The Product Department defines the stack matrix.
6. Prevent bugs during development
The JBS members help the development teams to create a test-first culture. Finding bugs during development is the most effective way to zero bugs.
7. Support Pizza, Bugs and Fun (PBF) events
There is a culture of organising Pizza, Bugs and Fun events from time to time - by Joomla User Groups or in conjunction with a JoomlaDay or other conferences. Given enough handling time, JBS members will be available on Glip for assistance.
Roles
Team Lead, Assistant Team Lead
These two members lead the team as defined in the bylaws. Their main obligation is to co-ordinate the team's activities and collaboration with other teams.
Member
All members are supposed to subscribe to Forum, Mailing Lists, Social Media channels, and StackExchange mentioned previously.
Members help users with handling issues on the tracker, with coding fixes, with sending pull requests, as well as with reviewing and testing patches.
Members have voting right according to the bylaws.
Contributor
Any person reporting bugs on the tracker, providing fixes, sending patch pull requests, or reviewing or testing patches is considered a JBS contributor.
Contributors have no voting right according to the bylaws.
References
- ↑ Joomla! Forum, especially Joomla! CMS 3.x Bug Reporting Forum
- ↑ Google Groups Joomla! CMS Development and Joomla! Framework Development
- ↑ Linkedin Official Joomla! Users Group, Facebook Joomla! Group
- ↑ StackExchange Joomla Q&A
- ↑ A workflow has to be defined for that, because the test must be executable with and without a proposed fix.
- ↑ This will be Gherkin based acceptance tests. The syntax is very easy to learn and is targeted at non-coders.
- ↑ No code should ever be merged without tests! We've seen Joomla breaking because of missing tests way too often.
<translate>
Become a Contributor
</translate>
<translate> All you need to start contributing is a GitHub account.</translate>
<translate> A good starting point is testing pull requests (PRs), as we always need at least 2 successful tests for each PR before it can be merged. Detailed instructions for testing Joomla! patches are found on the documentation site.</translate>
<translate> If you are comfortable with coding, you can create PRs for open issues as well.</translate>
<translate> We use Mattermost for team communication, so you are encouraged to create an account there, if you have not yet. The "PD Bug Squad" channel is for Bug Squad contributors. Drop a mail to the Bug Squad, if you can't get into that channel. You will be added manually then.</translate>
<translate> Joomla! uses GitHub as its code repository and the Joomla! Issue Tracker for reporting bugs. You will need your GitHub user account to</translate>
<translate>
- report issues on the CMS Issue tracker.</translate>
<translate>
- submit patches (PRs) against the Joomla code repository for bug fixes.</translate>
<translate>
- test patches using the Joomla! Patch Tester.</translate>
<translate>
Become a Member
</translate>
<translate> As a member of the Bug Squad, you are expected to mentor contributors, scan the various communication channels for potential issues, and to support the developers to prevent and fix bugs.</translate>
<translate> If you accept the challenge, send an email request to the Bug Squad with a short description of your expertise to request membership.</translate>
<translate> See Bug Squad Team</translate>
<translate>
The Joomla! Bug Squad uses Glip for team communication, so you are encouraged to create an account there, if you have not yet. The "Bug Squad Public Discussion" channel is for Bug Squad contributors. Drop a mail to the Bug Squad, if you can't get into that channel. You will be added manually then.
Additionally, you might want to subscribe to the Joomla! CMS Development Mailing list.</translate>
<translate> Joomla! uses GitHub as its code repository and the Joomla! Issue Tracker for reporting bugs.</translate>