Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MPS documentation lacks a review procedure #101

Open
UNAA008 opened this issue Jan 10, 2023 · 2 comments · May be fixed by #123
Open

MPS documentation lacks a review procedure #101

UNAA008 opened this issue Jan 10, 2023 · 2 comments · May be fixed by #123
Assignees
Labels
essential Will cause failure to meet customer requirements. Assign resources. process To do with process or procedure

Comments

@UNAA008
Copy link
Contributor

UNAA008 commented Jan 10, 2023

The Memory Pool System pull request merge procedure Pre-merge checklist mentions code review as an implied requirement for merging but there is no accessible documentation to describe how such reviews should be carried out.

Some of the documentation required will become available when #95 is satisfied but a specific procedure and/or guide is needed to support reviewers properly.

@rptb1 rptb1 added the process To do with process or procedure label Jan 11, 2023
@rptb1 rptb1 added the essential Will cause failure to meet customer requirements. Assign resources. label Jan 15, 2023
@rptb1
Copy link
Member

rptb1 commented Jan 18, 2023

It seems sensible for review logs to appear in GitHub metadata like #67 (review)

@rptb1
Copy link
Member

rptb1 commented Jan 20, 2023

These are internal Ravenbrook documents at the moment. See #95.

Here are links to the formal MM group review procedure and its adjuncts the kickoff, entry, checking, logging, brainstorm, editing, and exit procedures.

Related useful documents include:

Source material from "Software Inspections" [Gilb 1993]:

Source material from "Key Practices of the Capability Maturity Model Version 1.1" (before the CMM turned into an industry):

In addition there are multiple rule sets and checklists, all built up over years of defect prevention:

@rptb1 rptb1 mentioned this issue Feb 23, 2023
@rptb1 rptb1 self-assigned this Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
essential Will cause failure to meet customer requirements. Assign resources. process To do with process or procedure
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants