Skip to content
This repository was archived by the owner on Oct 30, 2019. It is now read-only.

Using the Issue Tracker

Jump to bottom
brian-murray35 edited this page Aug 19, 2015 · 13 revisions

Each BUILD module on GitHub has an Issue Tracker. This page describes how to do the following:

  • Report Bugs In the the Issue Tracker
  • Ask Questions Using the Issue Tracker
  • Propose Enhancements the Using Issue Tracker

IMPORTANT: Please review our our Communications Guidelines document before posting on the GitHub Issue Tracker.

###Report Bugs In the Issue Tracker

Follow these steps to report a bug you've found in BUILD:

  1. Before you report a bug, ensure that it is:
  • A real, current bug
  • Not a duplicate
  • Reproducible

  1. To report a bug, click the New Issue button in the Issue Tracker of the relevant module.

  2. Include the text #Bug in the title of issue.

  3. You can highlight issues you create in the Issue Tracker for the attention of a specific person by adding # and the relevant GitHub user name / identifier to the title of the issue. GitHub usernames are displayed in parentheses in the table below. If you do not identify a specific user, your issue is assigned to the most appropriate member of the team. To identify team member of individual BUILD modules, click here.

  4. We prioritize bugs reported as follows:

  • A good summary is provided.
  • The bug is well-documented.
  • A minimal example (with screen shots if applicable) is provided.
  • The recommended bug template is used.

  1. Enter a title that summarizes the issue, so that at a glance the community can identify whether it may be relevant to them. For example, if reporting that a feature on the Projects UI is displaying incorrectly, use 'Display issue with Projects UI', rather than 'UI Issue'. In addition, if the issue is related to a particular backlog item, please include the backlog issue number in the title.

  2. Enter a summary is specific to the bug.

  3. Click the Submit Issue button.

    To review the complete guidelines for reporting bugs, see Guidelines for Bug Reports.

    Once an issue has been created, you can click comment to add further comments or respond.

###Ask Questions Using Issue Tracker

  1. Click the New Issue button in the Issue Tracker of the relevant sub-project.

  2. Include the text #Question in the title of issue.

  3. You can highlight issues you create in the Issue Tracker for the attention of a specific person by adding # and the relevant GitHub user name / identifier to the title of the issue. GitHub usernames are displayed in parentheses in the table below. If you do not identify a specific user, your issue is assigned to the most appropriate member of the team. To identify team member of individual BUILD modules, click here.

  4. Ensure the summary reflects the essence of your question, to enable community members to identify if it is relevant to them.

  5. Click the Submit Issue button.

    Once an Issue has been created, you can click comment to add further comments or respond.

###Propose Enhancements Using Issue Tracker

  1. New feature or enhancement proposals can be created using the GitHub Issue Tracker for each sub-project.

  2. Include the text #Feature Enhancement in the title of issue.

  3. You can highlight issues you create in the Issue Tracker for the attention of a specific person by adding # and the relevant GitHub user name / identifier to the title of the issue. GitHub usernames are displayed in parentheses in the table below. If you do not identify a specific user, your issue is assigned to the most appropriate member of the team. To identify team member of individual BUILD modules, click here.

  4. Click the Submit Issue button.

Once an issue has been created, you can click comment to add further comments or respond.

Clone this wiki locally