About Ed-Fi Tracker
TODO: Expand this section.
The Ed-Fi Alliance tracks issues and feature requests in JIRA. This allows the Ed-Fi Community to:
...
All DATASTD tracker tickets are created with the OPEN status. In this phase, the a reporter can expect from the community additional information gathering, suggested best practices or workarounds, background information, and/or clarifications, depending on the nature of the ticket. If there exists related tickets they may be linked and the community can vote on tickets they'd like to see gain more visibility. From there, they have two possible paths: Under Analysis and Closed.
UNDER ANALYSIS
Periodically the Alliance and other community groups will review suggestions for changes to the data standard. When a ticket has been selected for this process, it is moved from OPEN to UNDER ANALYSIS. Those tickets that are resolved without requiring any further discussion or changes to the data standard will be CLOSED.
UNDER ANALYSIS
PLANNED FOR DEVELOPMENT
IN DEVELOPMENT
READY FOR REVIEW
SCHEDULED FOR RELEASE
...
. These can include recommendations for new features and fixes to the existing data model and are most often grouped by the data domain (e.g. Student Enrollment, Assessment). While tickets are in this phase, contributors may add notes and comments or ask additional questions of the community in preparation of the discussion. During analysis, additional notes and recommendations for next steps will be notated in the comments as well. From here, a ticket may be moved back to OPEN or on to PLANNED FOR DEVELOPMENT.
PLANNED FOR DEVELOPMENT
Tickets that have been approved for development during the UNDER ANALYSIS phase move here. Detailed steps on what is to be implemented along with a Data Standard Version are required. 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 ticket will revert to UNDER ANALYSIS. Otherwise, the ticket will move on to IN DEVELOPMENT.
IN DEVELOPMENT/READY FOR REVIEW
Tickets that are actively being developed fall into this phase. Changes are made to the model and data standard artifacts are completed and sent to the Alliance for a final review before merging those changes into a corresponding development branch. As with the previous phases, during this stage complications may arise that require changes or a hold to the development process. If this is the case, the ticket may revert back to PLANNED FOR DEVELOPMENT as adjustments to the implementation plan are made. Otherwise, the ticket will move on to SCHEDULED FOR RELEASE.
SCHEDULED FOR RELEASE
After the changes designated by a ticket are implemented and merged into the corresponding development branch in GitHub, a release is assigned to the ticket and it moves to this final phase before CLOSED.
CLOSED
There are two main ways that a ticket will end up CLOSED. The first are OPEN tickets that are resolved without requiring any further discussion or changes to the data standard. The second are tickets SCHEDULED FOR RELEASE after the release occurs. The common thread is the reported issue will have no further action taken.
Tracker Ticket Stories
Best Practices and Clarification
TODO: Insert an example of a ticket that is requesting the best way to store data elements. How to record multiple course parts in the StudentAcademicRecord and CourseTranscript is an example of this.
Reporting a Bug
TODO: Insert an example of a ticket that is requesting a fix for data that is currently included in the data standard. The StudentProgramAttendanceEvent needing a StudentProgramAssociation is an example of this. StartTime and EndTime for CalendarDate is another.
New Feature Request
TODO: Insert an example of a ticket that is requesting a new feature to the data standard. Adding EnrollmentType to the StudentSchoolAssociation is an example of this. Can mention that multiple state implementations have added elements for this as extensions.
...