Skip to content

Issue Review

Jump to bottom
A.J. Stein edited this page Apr 18, 2023 · 3 revisions

Purpose

This page documents different methods and approaches to reviewing the scope of work in an issue as complete.

Overview

For an issue, the specific requirements for the issue should be the acceptance criteria. Those acceptance criteria may have generic elements as defined by the issue templates, but a community or NIST OSCAL Team member should adapt them accordingly. Those acceptance criteria aside, team members may want an additional guidance on how to review the issue for completeness. One or more team members ought to use the acceptance and this guidance if it is unclear an issue is complete.

General Website Changes

Reference Model Changes

Code Changes, Pull Requests, and Code Review

Is there a style guide? Did we follow it?

Is it testable? Are the tests passing?

NOTE: This information exists for the benefit of NIST staff. Although the community may reference or inquire about content, this material is not explicitly intended for community support. The community may create issues to report bugs or request enhancements related to this documentation, but there is no support guarantees for this material. All issues will be considered on a case by case basis.

Standard Operating Procedures

Developer Knowledge Base

Team Members' Responsibilities

Clone this wiki locally