usnationalarchives / OPAProd

Tracking enhancements to OPAProd
1 stars 0 forks source link

National Archives Catalog issue tracker

=======

This is the project for tracking catalog issues. To create, view, or discuss issues, go directly to the tracker. This tracker is visible to all members of the catalog team.

Label and milestones

There are several labels which can be used to organize issues. Milestones can also be used to assign issues to a release. As well, issues can be assigned to particular team members if they are needed for decisionmaking or some other reason. Issues can be closed once resolved (or the team decides against them).

Currently, the only milestone is R1P2. The idea is that issues that are scheduled for inclusion in the next release will assigned to R1P2.

Use labels like requirement if it will need additional requirements, or design if not. You can also mark issues as open question, trivial, later, and so on. Any member of the team can view or change all labels.

For example, here is the first issue in the tracker: "Make all fields sortable in the API".

Tracking issue

A tracking issue (or "tracking bug") is a type of issue report which is used to track all open issues related to a bigger component. The issue report itself is just about the component, and then related issues are listed in the summary and their status is continuously updated. The tracking issues should use the "tracking issue" label, so that the label can be used to easily see summaries of all the major components.

For example, issue #8 is a tracking issue for advanced search. It is currently tracking issues #5, #6, and #7, which are all related to advanced search.

GitHub help

GitHub uses Markdown for formatting in issues. It's also how this file is displaying as formatted in the browser (hence the .md in README.md). You can use Markdown to hyperlink text, make bold and italic text, section headers, bulleted or numbered lists, and so on.

Refer here for help: https://help.github.com/articles/markdown-basics/