The team will utilize Github's issue tracking system to record and manage issues that are reported by users of the ODE in the field. These may include performance requests, found bugs, and new requests. The follow operating procedure highlights how the ODE development team will address and respond to reported issues.
Issue Repository: https://github.com/usdot-jpo-ode/jpo-ode/issues
Issue Types:
All reported issues will be attempted to be categorized into the follow categories. Within each category, the team will determine the appropriate next steps for addressing the issue.
| Category | Definition | Action Items |
|---|---|---|
| Help Wanted/ Question | Installation issues, general conversation, or clarifications around the existing product. | The team will attempt to address these ASAP. Often times, a quick call or email communication can quickly address these. |
| Bug | Any technical issues regarding installation or performance with the system. | The development team will evaluate these based on the pace of the current sprint, the technical complexity of the issue, and the priority for the user. Generally, the team will attempt to address bugs as soon as they can, ideally completing it as part of the sprint. Larger issues that will take significant development time will be factored into upcoming sprints. |
| Missing Feature | Identified features that are missing within the ODE that need to be added for a specific business/ user need. | Depending on the size and priority of the feature, new features will follow the sprint cycle as a user story. The story will be defined, estimated, and prioritized along with other stories in the backlog and incorporated into future sprints. In some situations, features may need to be deployed quickly as part of a hotfix, in which case the feature will be defined and worked upon ASAP. |
| Suggestion | Thoughts or ideas that will improve the ODE - process, feature, or other category. | Suggestions will be evaluated at the end of each sprint, and addressed accordingly. The issue tracker serves as an opportunity for users of the ODE to raise thoughts and changes that may contribute to the community. This category is meant as a forum for collaborators to contribute towards changes that may help the project. |
Performance Metrics:
In an effort to improve the overall performance and stability of the project, the team will periodically measure the project using the following criteria to assess the performance maturity of the project.
- Outstanding Number of Issues: Total number of outstanding issues reported to the project
- Response Time: Overall time taken to address and issue
- Issue Severity: Complexity of the solution taken to address and issue
Issue Reports:
TBD