Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

All bugs, enhancement requests, and questions from the Ed-Fi Community should be entered as issues in Ed-Fi Tracker using the following issue types:

Issue TypeDescription

A problem which impairs or prevents the functions of the product(warning) Note this is a different issue type than. A Bug Report will convert to a Bug once it has been verified by the Ed-Fi team.

An improvement or enhancement to an existing feature or task.

A new feature of the product, which has yet to be developed. See How To: Submit a Feature Request.

A question or issue that is not directly related to a bug, improvement or feature. (info) Questions not directly related to the product can be posted to this forum instead.




Step-by-Step Guide

This section provides a walkthrough of submitting an issue to the Alliance.

  1. Select the project to which you want to submit your issue. See the article Technical Community Guidelines for a summary of projects and access requirements.
  2. Click the "Create" button.
  3. Select the Issue Type.
  4. Anchor
    requiredinformation
    requiredinformation
    Enter following information:
    1. Summary. A brief description of the issue.
    2. Issue Description. Be detailed. For improvements and new feature requests, please include use case details. For bugs, please include the steps to reproduce the bug.
    3. Priority. Indicate the importance of the issue.
    4. Components. A list of components that will be affected by the issue.
    5. Affects Version/s. The specific version, if any, affected by the issue.
    6. Labels:
      1. If you plan to submit a pull request for the issue, please add the label "licensee-fix" so the community knows you will be working on it. 
      2. If you believe the issue will be a breaking change, add the label "breaking-change" so we can begin our evaluation in advance of a change.
    7. Reporter. Defaults to current user.
    8. Attachment
  5. Click Create and you're done.

Community Feedback Workflow

See the workflow below to understand how your issue will be handled.

Image RemovedImage Added

StatusDescription
OPEN

Every tracker issue created starts in the OPEN status and is assigned to a Level 1 (L1) support team partner to confirm the basic information provided is sufficient for analysis.

  • For Question issue types, L1 will answer via comments then transition to the CLOSED status when sufficiently addressed.
  • For any other issue type, no other activity is assumed when in this status. Once the basic details of the issue are confirmed, it will transition to the UNDER ANALYSIS status. 
UNDER ANALYSISIn this status, the L1 support partner will triage the issue and work to refine the details (mainly the Description) with the aim of providing actionable feedback for the Ed-Fi development team. Depending on the nature of the issue, the reporter can expect from the community additional information gathering, suggested best practices or workarounds, background information, and/or clarifications. If the feedback is deemed actionable for Ed-Fi development, it will be labeled 'recommended' and assigned to the Ed-Fi Product Owner. The Product Owner will then decide whether to approve it for development.
PLANNED FOR DEVELOPMENTIssues that have been approved for development transition here from the UNDER ANALYSIS status. It is important to note while there is a plan to develop tickets in this phase, it is not a guarantee the changes will become part of a future release. Often times during development additional requirements or unforeseen complications can arise and more information may be necessary or additional steps taken before a ticket can move forward. When this is the case, the issue make transition back to UNDER ANALYSIS. Otherwise, the issue will move on to IN DEVELOPMENT.
IN DEVELOPMENTIssues that are actively being developed fall into this status. Note that the workflow for Ed-Fi development-related issues (e.g. Story, Epic, Task, Bug) are different than feedback issues which is why you will likely see one or more development-related issues linked to the source feedback issue.  As with the previous status, complications may arise that require changes or a hold to the development process. If this is the case, the ticket may revert back to a previous status. 
READY FOR REVIEWOnce the related development issues have been addressed, the feedback issue may be transitioned to this status to confirm all aspects of the originating requirements are addressed. Not all feedback will transition through this status.
CLOSEDThe final status for all tracker issues where there is no further action necessary. The Resolution field will indicate how the issue was resolved.

Content by Label
showLabelsfalse
max5
spacesETKB
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel in ("contribution-guidelines","how-to","submit-issues") and type = "page" and space = "ETKB"
labelshow-to contribution-guidelines submit-issues

Page properties
hiddentrue


Related issues