From 4f146d8cb1c15d8b8c2c3f756b6018af0e825ab2 Mon Sep 17 00:00:00 2001 From: jpound Date: Tue, 3 Sep 2024 16:15:59 -0400 Subject: [PATCH] Update ASSESSMENT_TOOL.md Adding format for consistency. Signed-off-by: jpound --- organizations/ASSESSMENT_TOOL.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/organizations/ASSESSMENT_TOOL.md b/organizations/ASSESSMENT_TOOL.md index 5f71f1a..85ec254 100644 --- a/organizations/ASSESSMENT_TOOL.md +++ b/organizations/ASSESSMENT_TOOL.md @@ -2,12 +2,12 @@ # Assessment Tool -The Assessment Tool allows you to assess the readiness of your pre-existing GitHub `repository`, before importing it with the toolkit. +The `Assessment Tool` allows you to assess the readiness of your pre-existing GitHub `repository`, before importing it with the toolkit. It is used to check whether toolkit guardrails are already in place in the `repository`, as well as any settings required at the `organization` level. ## Running the Assessment Tool -The Assessment Tool is available as part of the `GitHub Foundations CLI` tool, found [here](https://github.com/FociSolutions/github-foundations-cli/releases) +The `Assessment Tool` is available as part of the `GitHub Foundations CLI` tool, found [here](https://github.com/FociSolutions/github-foundations-cli/releases) To run an assessment check on a repository, run the following command: