mitre / mitre/ts-inspec-objects

Create Checklist Markdown for Delta

Open
#29 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
4
Forks
2
Avg merge
3m
Merged PRs (30d)
21

Description

Add a markdown file with checkboxes for controls with updates so the human user can check off and keep organized during the review. See the main comment in the Red Hat 7 delta work as an example. It could be useful to put some grouping, like "new controls" or "similar controls" in some way. Or "check text updated" or so on.

https://github.com/mitre/redhat-enterprise-linux-7-stig-baseline/pull/189

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the main comment in the Red Hat 7 delta work, especially PR 189, to understand the expected checklist style. Create a Markdown file listing controls with updates as checkboxes, using useful groupings such as new controls, similar controls, or updated text; it is done when a reviewer can use it to track the Delta review.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.