Portal

Difference between revisions of "Bug Squad/Intro"

From Joomla! Documentation

< Portal:Bug Squad
m (couple changes)
 
(28 intermediate revisions by 9 users not shown)
Line 1: Line 1:
−
[[Image:workgroups_bugsquad.jpg|right]]
+
<noinclude><languages /></noinclude>
−
<big>This is where you will find all the information you need as a Joomal! Bug Squad member.</big>
+
<translate>
 +
== Purpose == <!--T:7-->
 +
</translate>
  
−
The Joomla! Bug Squad (JBS) is a team within the production working group. Their job is to identify and fix bugs in Joomla. This includes the following:
+
<translate><!--T:8-->
 +
'''The purpose of the Joomla! Bug Squad (JBS) is to reduce the number of bugs in Joomla.'''</translate>
  
−
* Scan the [http://forum.joomla.org/viewforum.php?f=199 Joomla! Bug Reporting Forum] and [http://forum.joomla.org/viewforum.php?f=579 Joomla! 2.5 Bug Reporting Forum] for reported issues and help community members with solving these issues.
+
<translate><!--T:9-->
−
* Maintaining the [[http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=32 Version 1.5 Bug Tracker]] and [[http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8103 CMS Issue Tracker]] .
+
This is valid not only for the CMS, but for every Joomla (sub-)project.</translate>
−
* Fix reported bugs and resolve reported issues according to the [[Bug Tracking Process]].
+
 
 +
<translate>
 +
== Function == <!--T:10-->
 +
</translate>
 +
 
 +
<translate><!--T:11-->
 +
The Joomla! Bug Squad reduces the number of bugs in Joomla by following these approaches:</translate>
 +
 
 +
<translate><!--T:12-->
 +
'''1. Scan the Forum<ref>[http://forum.joomla.org Joomla! Forum], especially [[jforum:728|Joomla! CMS 3.x Bug Reporting Forum]]</ref>, Mailing Lists<ref>Google Groups [https://groups.google.com/group/joomla-dev-cms Joomla! CMS Development] and
 +
[https://groups.google.com/group/joomla-dev-framework Joomla! Framework Development]</ref>, Social Media<ref>Linkedin [https://www.linkedin.com/groups/52867 Official Joomla! Users Group], Facebook [https://www.facebook.com/groups/joomlanospam/ Joomla! Group]</ref>, Stack Overflow<ref>StackExchange [http://joomla.stackexchange.com/ Joomla Q&A]</ref>, and other external resources for reported issues.'''</translate>
 +
 
 +
<translate><!--T:13-->
 +
It is not up to the JBS to provide support on those channels (although it would be appreciated), but to</translate>
 +
 
 +
<translate><!--T:14-->
 +
* identify and confirm possible bugs,</translate>
 +
<translate><!--T:15-->
 +
* assist the poster to create an issue ticket on the tracker</translate>
 +
<translate><!--T:16-->
 +
* create an issue ticket on the tracker, if the poster is not able to do that</translate>
 +
<translate><!--T:17-->
 +
* leave a reference to the tracker item on the channel</translate>
 +
 
 +
<translate><!--T:18-->
 +
The sooner this happens after the original post, the better the overall perception will be.</translate>
 +
 
 +
<translate><!--T:47--> The main tool - and thus the single point of truth - is the [https://issues.joomla.org/ issue tracker], which again is a customised view on several [https://issues.joomla.org/projects GitHub repositories]. All relevant information from the channels mentioned above are consolidated here.</translate>
 +
 
 +
<translate><!--T:19-->
 +
'''2. Confirm bugs using a test<ref>A workflow has to be defined for that, because the test must be executable with and without a proposed fix.</ref>.'''</translate>
 +
 
 +
<translate><!--T:20-->
 +
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.</translate>
 +
 
 +
<translate><!--T:21-->
 +
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<ref>This will be Gherkin based acceptance tests. The syntax is very easy to learn and is targeted at non-coders.</ref>.</translate>
 +
 
 +
<translate><!--T:22-->
 +
Until that library exists, manual confirmation is conducted.</translate>
 +
 
 +
<translate><!--T:23-->
 +
In conjunction with the confirmation, JBS also makes sure each issue has the correct Type, Severity, and Priority.</translate>
 +
 
 +
<translate><!--T:24-->
 +
'''3. Fix bugs'''</translate>
 +
 
 +
<translate><!--T:25-->
 +
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<ref>No code should ever be merged without tests! We've seen Joomla breaking because of missing tests way too often.</ref>.</translate>
 +
 
 +
<translate><!--T:26-->
 +
If the development team can't take over, a fix will be provided by JBS contributors.</translate>
 +
 
 +
<translate><!--T:27-->
 +
'''4. Follow up issues'''</translate>
 +
 
 +
<translate><!--T:28-->
 +
Whenever an issue gets stuck, JBS leadership will investigate the reasons and put the issue on track again.</translate>
 +
 
 +
<translate><!--T:29-->
 +
'''5. Testing patches'''</translate>
 +
 
 +
<translate><!--T:30-->
 +
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.</translate>
 +
 
 +
<translate><!--T:31-->
 +
'''6. Prevent bugs during development'''</translate>
 +
 
 +
<translate><!--T:32-->
 +
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.</translate>
 +
 
 +
<translate><!--T:33-->
 +
'''7. Support Pizza, Bugs and Fun (PBF) events'''</translate>
 +
 
 +
<translate><!--T:34-->
 +
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.</translate>
 +
 
 +
<translate>
 +
== Roles == <!--T:35-->
 +
</translate>
 +
 
 +
<translate>
 +
=== Team Lead, Assistant Team Lead === <!--T:36-->
 +
</translate>
 +
 
 +
<translate><!--T:37-->
 +
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.</translate>
 +
 
 +
<translate>
 +
=== Member === <!--T:38-->
 +
</translate>
 +
 
 +
<translate><!--T:39-->
 +
All members are supposed to subscribe to Forum, Mailing Lists, Social Media channels, and StackExchange mentioned previously.</translate>
 +
 
 +
<translate><!--T:40-->
 +
Members help users with handling issues on the tracker, with coding fixes, with sending pull requests, as well as with reviewing and testing patches.</translate>
 +
 
 +
<translate><!--T:41-->
 +
Members have voting right according to the bylaws.</translate>
 +
 
 +
<translate>
 +
=== Contributor === <!--T:42-->
 +
</translate>
 +
 
 +
<translate><!--T:43-->
 +
Any person reporting bugs on the tracker, providing fixes, sending patch pull requests, or reviewing or testing patches is considered a JBS contributor.</translate>
 +
 
 +
<translate><!--T:44-->
 +
Contributors have no voting right according to the bylaws.</translate>
 +
 
 +
<translate>
 +
 
 +
== References == <!--T:45-->
 +
</translate>
 +
 
 +
<references/>
 +
 
 +
<noinclude>
 +
<translate>
 +
<!--T:46-->
 +
[[Category:Landing subpages|Landing subpages]]
 +
</translate>
 +
</noinclude>

Latest revision as of 05:30, 23 December 2017

Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎Türkçe • ‎español • ‎français • ‎português • ‎български • ‎中文（台灣）‎

Purpose[edit]

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[edit]

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[edit]

Team Lead, Assistant Team Lead[edit]

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[edit]

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[edit]

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[edit]

  1. ↑ Joomla! Forum, especially Joomla! CMS 3.x Bug Reporting Forum
  2. ↑ Google Groups Joomla! CMS Development and Joomla! Framework Development
  3. ↑ Linkedin Official Joomla! Users Group, Facebook Joomla! Group
  4. ↑ StackExchange Joomla Q&A
  5. ↑ A workflow has to be defined for that, because the test must be executable with and without a proposed fix.
  6. ↑ This will be Gherkin based acceptance tests. The syntax is very easy to learn and is targeted at non-coders.
  7. ↑ No code should ever be merged without tests! We've seen Joomla breaking because of missing tests way too often.
Retrieved from "https://docs.joomla.org/index.php?title=Portal:Bug_Squad/Intro&oldid=474757"