Skip to content

Commit

Permalink
Suggested text changes from code review
Browse files Browse the repository at this point in the history
This commit updates Development guide
Readme and Skeletonize existing
repository according to requested
changes for wording, grammar,
replacing text and delete emoji.
  • Loading branch information
dv4harr10 committed Feb 28, 2024
1 parent ae5f047 commit ffbea4a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
14 changes: 7 additions & 7 deletions project_setup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ branch protection - [see our branch protection guide for details](branch-protect
## Contents ##

- [Adding a skeleton configuration to an existing repository](#adding-a-skeleton-configuration-to-an-existing-repository)
- [Using the gh-skeleton `gh` extension to start a new repository 💀🛠](#using-the-gh-skeleton-gh-extension-to-start-a-new-repository-)
- [Using the gh-skeleton `gh` extension to start a new repository](#using-the-gh-skeleton-gh-extension-to-start-a-new-repository-)
- [Selecting a skeleton](#selecting-a-skeleton)
- [Cloning a selected skeleton](#cloning-a-selected-skeleton)
- [Create and publish the GitHub repository](#create-and-publish-the-github-repository)
Expand Down Expand Up @@ -51,11 +51,11 @@ First, identify a suitable skeleton project to use as the starting point
for your new repository. For a list of available skeletons, see the
[Skeleton List](skeleton-list.md) or use the following command:

```bash
gh skeleton list
```

```console
$ gh skeleton list



Available skeletons in cisagov:

skeleton-python-library
Expand Down Expand Up @@ -91,13 +91,13 @@ for publication. The tool will print out each command it is issuing
and its result.

```console
gh skeleton clone [options] <parent-repo-name> <new-repo-name>
$ gh skeleton clone [options] <parent-repo-name> <new-repo-name>
```

For example, to create a project based on `skeleton-ansible-role` named
`ansible-role-quantum-rng` in your local `~/projects` directory:

```bash
```console
gh skeleton clone --change-dir ~/projects skeleton-ansible-role ansible-role-quantum-rng
```

Expand Down
8 changes: 4 additions & 4 deletions project_setup/skeletonize-existing-repository.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Skeletonize an Existing Repository #

Skeletonizing a repository standardizes our development setup and environment,
Skeletonizing a repository standardizes our development setup and environment
and enables our [Lineage GitHub Action](https://github.com/cisagov/action-lineage/)
to keep the repository updated and standardized. The purpose of the
instructions here is to describe how to skeletonize an existing non-skeletonized
instructions here are to describe how to skeletonize an existing non-skeletonized
repository.

## About ##
Expand All @@ -21,7 +21,7 @@ The general outline of how to add a skeleton to an existing repository is:

1. [Add the skeleton as a remote](#add-the-skeleton-as-a-remote) to the
existing non-skeletonized repository
1. Pull with `--allow-unrelated-histories`
1. Pull with `git pull--allow-unrelated-histories skeleton parent`
1. [Fix merge conflicts](#fix-merge-conflicts)
1. [Review non-conflicting changes](#review-non-conflicting-changes) to
prevent merging destructive upstream changes
Expand Down Expand Up @@ -108,7 +108,7 @@ This step includes such activities as:

- Update `setup.py` with non-example information
- Arrange into appropriate folders, such as `src` and `test`
- Update the `codeowners` file to reflect subject matter expertise and
- Update the `.github/CODEOWNERS` file to reflect subject matter expertise and
codebase familiarity
- Aim to have at least two codeowners for every repository

Expand Down

0 comments on commit ffbea4a

Please sign in to comment.