PDS Issue Tracking ================== - `Overview <#Overview>`__ - `Getting Started with Zenhub <#getting-started-with-zenhub>`__ - `Issue Creation Best Practices <#issue-creation-best-practices>`__ - `Help with Zenhub <#help-with-zenhub>`__ - `References <#references>`__ -------------- Overview -------- The Planetary Data System has several issue tracking and project management mechanisms that serve different purposes: +-------+-------------------------------------+--------------+-------+ | S | Applicable Nodes / Projects | Description | A | | ystem | | | ccess | +=======+=====================================+==============+=======+ | `PDS | PDS4 Standards Change Control Board | This JIRA is | A | | J | | used | ccess | | IRA < | | specifically | is | | https | | for tracking | restr | | ://pd | | PDS4 | icted | | s-jir | | Information | to | | a.jpl | | Model | PDS | | .nasa | | Software | perso | | .gov/ | | Change | nnel, | | secur | | Requests | or | | e/Das | | (SCRs) and | `upon | | hboar | | their | reque | | d.jsp | | approval | st `__ | | through the | ailto | | | | Change | :pds- | | | | Control | opera | | | | Board. Once | tor@j | | | | and SCR is | pl.na | | | | approved, | sa.go | | | | the | v>`__ | | | | im | | | | | plementation | | | | | will be | | | | | tracked in | | | | | the `PDS4 | | | | | Information | | | | | Model | | | | | repo `__ | | +-------+-------------------------------------+--------------+-------+ | Githu | All open sourced PDS projects | Issues are | P | | b.com | | created in | ublic | | I | | their | a | | ssues | | appropriate | ccess | | | | `NASA-PDS | | | | | and NASA-PDS | | | | | repositor | | | | | ies `__ | | +-------+-------------------------------------+--------------+-------+ | `Z | All open sources PDS projects | `Zenhub | A | | enhub | managed by PDS Engineering Node | <#Zenhub>`__ | ccess | | PDSEN | | is utilized | `avai | | Works | | for sprint | lable | | pace | | planning, | upon | | `__ | | space | | | | | -5c87 | | | | | e859b | | | | | 7a087 | | | | | 2dd10 | | | | | b87c5 | | | | | /boar | | | | | d?rep | | | | | os=18 | | | | | 69141 | | | | | 79,22 | | | | | 57412 | | | | | 45,24 | | | | | 71825 | | | | | 82,17 | | | | | 93795 | | | | | 37,19 | | | | | 26175 | | | | | 33,21 | | | | | 11899 | | | | | 58,24 | | | | | 52169 | | | | | 97,23 | | | | | 60865 | | | | | 58,23 | | | | | 60991 | | | | | 03,25 | | | | | 31084 | | | | | 83,20 | | | | | 02803 | | | | | 92,25 | | | | | 16647 | | | | | 03,17 | | | | | 02078 | | | | | 12,19 | | | | | 35726 | | | | | 40,19 | | | | | 87170 | | | | | 28,19 | | | | | 38006 | | | | | 15,22 | | | | | 59560 | | | | | 31,84 | | | | | 49160 | | | | | 9,199 | | | | | 73969 | | | | | 0,198 | | | | | 51722 | | | | | 2,193 | | | | | 56028 | | | | | 1>`__ | | | | +-------+-------------------------------------+--------------+-------+ | JPL | PDS Engineering Internal Projects | Github | A | | G | | Issues / | ccess | | ithub | | Zenhub | restr | | Enter | | Internal EN | icted | | prise | | software and | to | | | | operations | JPL | | | | projects and | pers | | | | issue | onnel | | | | tracking | only | | | | (`De | | | | | velopment `__, | | | | | `Op | | | | | erations `__) | | +-------+-------------------------------------+--------------+-------+ 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. - `How to use Zenhub `__ - `Zenhub Support `__ References ---------- - https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53 - https://help.github.com/en/enterprise/2.18/user/github/writing-on-github/autolinked-references-and-urls#issues-and-pull-requests