Issues Guidelines

Note: These are guidelines, not rules.

Assignee

Issues are usually assigned by the person who will be working on the issue. But, if it is clear who maintains the resource or code related to the issue, a manager may assign that person.

For example, an issue with the TurnKey Website or TKLBAM should be assigned to @lirazsiri. An issue with the TurnKey Hub or TurnKey Installer should be assigned to @alonswartz.

For reference, components have a maintainer field in debian/control. Appliances have a maintainer field in the changelog.

Lastly, issues and their comments may reference a user by name requesting their input, which will trigger an email notification.

Labels

All issues should be labeled to ease the burden of managing, handling and tracking of issues.

Priority

• critical: The one and only priority label. Issues labeled as critical should be handled asap. All other issues are considered of normal priority and will be handled on per-issue basis.

Status

• confirmed: When an issue has been reproduced by a third party it is more likely to be dealt with.
• inprogress: The assignee of the issue should label the issue as inprogress when starting work. Once completed, the label should be removed and marked as closed.
• invalid: The issue is a support request or not applicable to TurnKey Linux. Invalid issues should be marked as closed.

Type

• bug: Self explanatory.
• feature: Self explanatory.

Freestyle

When an issue relates to a component or an existing appliance, it should be labeled as so, for example:

• hub: An issue with the TurnKey Hub.
• website: An issue with the TurnKey Website.
• di-live: An issue with the TurnKey installer.
• core: A bug in all TurnKey appliances.
• wordpress: A bug in TurnKey Wordpress.

Cross referencing issues

When an issue relates to a specific component or appliance, the maintainer might want to create a cross reference.

Even if there is no cross reference, issues in the tracker can be automatically closed and reference created by including close|closes|closed|fixes|fixed turnkeylinux/tracker#XX in the commit message.

It is recommended to let the maintainer know about the issue by referencing their name in a comment. (see assignee above).