PDS Issue Tracking¶
Overview¶
The Planetary Data System has several issue tracking and project management mechanisms that serve different purposes:
S ystem |
Applicable Nodes / Projects |
Description |
A ccess |
---|---|---|---|
`PDS J IRA < https ://pd s-jir a.jpl .nasa .gov/ secur e/Das hboar d.jsp a>`__ |
PDS4 Standards Change Control Board |
This JIRA is used specifically for tracking PDS4 Information Model Software Change Requests (SCRs) and their approval through the Change Control Board. Once and SCR is approved, the im plementation will be tracked in the PDS4 Information Model repo |
A ccess is restr icted to PDS perso nnel, or upon reque st |
Githu b.com I ssues |
All open sourced PDS projects |
Issues are created in their appropriate NASA-PDS and NASA-PDS repositor ies |
P ublic a ccess |
All open sources PDS projects managed by PDS Engineering Node |
Zenhub is utilized for sprint planning, management, and reporting by integrating all PDS projects into one visual workspace |
A ccess avai lable upon reque st |
|
JPL G ithub Enter prise |
PDS Engineering Internal Projects |
Github Issues / Zenhub Internal EN software and operations projects and issue tracking (De velopment, Op erations) |
A ccess restr icted to JPL pers onnel only |
Getting Started with Zenhub¶
Go to the applicable board to view / create / update new tickets: * PDS EN Github.com Development * PDS EN JPL Internal Development * PDS EN JPL Internal Operations
Alternatively, you can install the Zenhub Chrome/Firefox extension to view Zenhub within Github: * Zenhub for Github.com * Zenhub for JPL Github Enterprise
Issue Creation Best Practices¶
The PDS has uses the article “Naming Guide For Task, Bug, and User Story Titles” for issue best practices.
Here are some high-priority best practices we really want to try to follow:
In general, for tasks, bugs, and new features, at minimum, start the title with a verb (e.g. Ingest some data from somewhere or Update this page with some change)
Title should be able to tell someone what was fixed or completed
We plan on using these issue titles for generating changelogs and report automatically
Use autolinked references wherever possible for traceability
Using references is a HUGE benefit in streamlining productivity, project management, provenance, and requirements/test traceability.
Help with Zenhub¶
We use Zenhub to visualize all our tickets across Github.com repositories.