...
...
...
How To Information
...
| title | Issue Tracker First-Time Login |
|---|
Issue Tracker First-Time Login
To access our Issue Tracker, you will need a login. We generally use your GitHub username. See below for instructions on how to log in for the first time.
Step-by-Step Guide
- Go to tracker.ed-fi.org.
- Click the "Can't access your account?" link.
- Select Username, input your GitHub username and click Send.
- An email will arrive with a link to request a new password.
- If you can't log in or the e-mail does not arrive, please contact our administrator. Don't forget to tell us your e-mail and GitHub username in the request details.
| Info |
|---|
You must be an Ed-Fi Licensee to be granted a login to our Tracker system. You can find licensing information on our website. |
...
| title | Submit an Issue |
|---|
Submit an Issue
Issues should be entered for bugs and enhancement requests for our core tech components. Questions can be posted to this forum.
Step-by-Step Guide
...
...
- Select the Project and Issue Type. Data model tickets are placed in the Data Standard project and prefixed with "DATASTD-" in their ticket number.
...
We ask that you use the following issue
...
...
...
...
...
...
...
Issues are assigned to the core technical team project lead. The project lead is the point of contact for code reviews and responsible for integrating pull request submissions into the Ed-Fi core code base.
...
| title | New Feature Requests User Story |
|---|
New Feature Requests User Story
Writing a User Story
When submitting a feature request, it is standard practice in Agile development to do so in the form of a "user story." A user story is a simple account of a feature told from the perspective of a user that is designed to ensure that requests are communicated with the baseline data needed for a developer and others to quickly understand the feature and why it is needed. A user story look like this:
As a {type of user},
I want {goal}
because {reason}.
The parts of a user story:
- {type of user} - Identify who the specific user type is, as in "As a classroom teacher..." or "As the system database administrator...". A not so good example would be "As a user of the software...". If there is a characteristic that is critical to understanding this user, include that too: "As a classroom teacher who is using this software for the first time...".
- {goal} - Say what the user is trying to do or accomplish. Try to describe the interaction as an outcome or goal, and resist describing it as a series of steps. "As a classroom teacher, I want to download the assessment results in text file format...".
- {reason} - Say why the user wants to accomplish the goal.
A full example would be:
As a classroom teacher,
I want to download the assessment results in text file format
because I may not have Excel or other required software applications installed on my computer.
Entering User Stories in Tracker
When submitting a feature request in Jira, put the whole user story in the "Summary" field. A user story is designed to be a short but effective vehicle for communicating a need at a glance so others can see what is wanted, who needs it, and why. This allows it to be understood, sorted, voted on, etc. very quickly.
Entering Descriptive Details and Acceptance Criteria in Tracker
In the "Description" field, you can add any additional details you feel are important, or make suggestions as to the best way to supply this feature. Given the user story above, you might write: "Many teachers are using Google Docs instead of Microsoft Office, so when files are downloaded in Excel format they have trouble opening them" or "I think a drop-down offering an Excel and Text file options in the left corner would be best.".
Finally, one best practice we recommend is to add to the description what is called "acceptance criteria." Acceptance criteria are suggestions designed to let the software developer know when the story is complete. To continue the example above, what if the teacher is able to download the assessment results, but her computer does not recognize the file as a text file? An acceptance criteria to fix this might look like this:
When the file is downloaded, please ensure that it is recognized by the system as a text file and opens in the right application (e.g,. put a ".txt" on it, etc), including on my iPad.
This gives the developer who handles this story a list of specific item to test to ensure the story was completed successfully.
| Info |
|---|
You may also want to use visual panels to communicate related information, tips, or things users need to be aware of. |
...
Track an Issue
The Ed-Fi Tracker allows for users to easily follow tickets and receive email updates when new comments are posted, changes to the ticket are made, or the status is updated.
- To track an issue, go to http://tracker.ed-fi.org and log in if you are not already.
- You can search for a ticket using the search at the top right of the page or with the filter.
- To expand the filter options, click View all issues and filters.
- Once you have selected the ticket you wish to track, click the Start watching this issue hyperlink.
The number to the left shows how many people are currently watching this issue. - As updates occur to the ticket, you will receive an email alert with a link to the ticket.
- To stop tracking a ticket, click the Stop watching this issue hyperlink.
Vote or Comment on an Issue
Often others have similar issues to yours and tickets on those issues already exist. It is a good idea, therefore, to search for existing issues and add your comments to those tickets where possible. Commenting or voting for an issue is the best way to ensure the Ed-Fi community has as much information as possible, all in the same place.
- To vote or comment on an issue, go to http://tracker.ed-fi.org and log in if you are not already.
- You can search for a ticket using the search at the top right of the page or with the filter.
- To expand the filter options, click View all issues and filters.
- Once you have selected the ticket, you can vote by clicking the Vote for this issue hyperlink on the right side of the page.
- And you can comment by scrolling down to the Comments section.
- Click the Comment button and include information like additional use cases or questions.
Data Standard Ticket Workflow
The life of a DATASTD ticket has many phases. To help understand the process, below is the overall workflow for the DATASTD tracker project followed by a few common paths DATASTD tickets take.
OPEN
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
...
...
...
...
...
...
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
...