Track: Issue Tracker

Last modified by Ecaterina Moraru (Valica) on 2018/06/15 10:23

Task 1: Report an issue

You can report issues to the XWiki issue tracker (you'll need to register an account there the first time). The issue tracker project to report in is usually the Platform project. But if the issue is related to an extension, you need to identify the correct location to report it. 

Before reporting a new issue, you need to make sure the issue has not been already reported.

When reporting an issue there are some details you need to provide in order for people to understand how to reproduce the problem and in what conditions.

Task 2: Pick an issue to fix

If you want to fix a problem inside XWiki or its extensions, first you need to make sure there is an existing issue describing the problem. You will need to make a reference to the issue number in your commit message.

If you are looking for beginner issues, we suggest you pick some of our Onboarding issue and start implementing it. When you know the solution, you should create a Pull Request in the appropriate repository and follow the code contribution guidelines.

For more specific issues that you need find, use the query language in the search advanced section to filter what you need. This is an example that filters easy, open issues in the Web Templates category for XWiki Plaform:

project = XWIKI AND component = "Web - Templates & Resources"
  AND Difficulty in (Easy, Trivial) AND resolution = Unresolved

In case you are looking for issues related to a particular extension, you need to find the project where those issues are reported to. Usually the tracker is marked in the extension's page, in the "Issues" section. Here is an example of a query that filters open issues for the Forum application: 

project = XAFORUM AND status = Open

With these filtering techniques you can limit the issues that occur in a particular browser, XWiki version, component or extension.

We organize weekly XWiki Days, majority of these events being bugfixingdays. You are more than welcomed to join and helps us squash some bugs. We are using a dedicated dashboard in order to easily track bugs.


Get Connected