fix typos and brand names (#127)

* chore: fix typos Apline => Alpine extention => extension recusively => recursively Use Oxford list in an enumeration * chore: fix brand names These are brand names, they are registered with a specific case - Alpine - GitHub - macOS - Go - Scratch - Ubuntu
Boeing · Mar 29, 2024 · 1ecceed · 1ecceed
1 parent b722bac
commit 1ecceed
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 17 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,16 +6,16 @@ We welcome contributions! We want to make contributing to this project as easy a
 - Submitting a fix
 - Proposing new features
 
-## We Develop with Github
-We use github to host code, to track issues and feature requests, as well as accept pull requests.
+## We Develop with GitHub
+We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
 
-## We Use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow), So All Code Changes Happen Through Pull Requests
-Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). We actively welcome your pull requests:
+## We Use [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow), So All Code Changes Happen Through Pull Requests
+Pull requests are the best way to propose changes to the codebase (we use [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). We actively welcome your pull requests:
 
-1. Fork the repo and create your branch from `main`.
+1. Fork the repository and create your branch from `main`.
 2. If you've added code that should be tested, add tests.
 3. Ensure the test suite passes.
 4. Submit that pull request!
 
-## Report bugs using Github's [issues](https://github.com/boeing/config-file-validator/issues)
+## Report bugs using GitHub's [issues](https://github.com/boeing/config-file-validator/issues)
 We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/Boeing/config-file-validator/issues/new);
diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ There are several ways to install the config file validator tool
 
 ### Docker
 
-We offer alpine, ubuntu, and scratch containers
+We offer Alpine, Ubuntu, and Scratch containers
 
 #### Alpine
 
@@ -128,7 +128,7 @@ validator /path/to/search
 ![Standard Run](./img/standard_run.png)
 
 #### Multiple search paths
-Multiple search paths are supported and the results will be merged into a single report
+Multiple search paths are supported, and the results will be merged into a single report
 ```
 validator /path/to/search /another/path/to/search
 ```
@@ -193,9 +193,9 @@ docker run -it --rm -v /path/to/config/files:/test config-file-validator:1.5.0 /
 ![Docker Standard Run](./img/docker_run.png)
 
 ## Build
-The project can be downloaded and built from source using an environment with golang 1.21 installed. After a successful build, the binary can be moved to a location on your operating system PATH.
+The project can be downloaded and built from source using an environment with Go 1.21 installed. After a successful build, the binary can be moved to a location on your operating system PATH.
 
-### MacOS
+### macOS
 #### Build
 ```
 CGO_ENABLED=0 \

diff --git a/cmd/validator/validator.go b/cmd/validator/validator.go
@@ -1,5 +1,5 @@
 /*
-Validator recusively scans a directory to search for configuration files and
+Validator recursively scans a directory to search for configuration files and
 validates them using the go package for each configuration type.
 
 Currently Apple PList XML, CSV, HCL, HOCON, INI, JSON, Properties, TOML, XML, and YAML.

diff --git a/index.md b/index.md
@@ -63,9 +63,9 @@ There are several ways to install the config file validator tool
 
 ### Docker
 
-We offer alpine, ubuntu, and scratch containers
+We offer Alpine, Ubuntu, and scratch containers
 
-#### Apline 
+#### Alpine
 
 ```
 docker pull ghcr.io/boeing/config-file-validator:v1.5.0
@@ -190,9 +190,9 @@ docker run -it --rm -v /path/to/config/files:/test config-file-validator:1.5.0 /
 ![Docker Standard Run](./img/docker_run.png)
 
 ## Build
-The project can be downloaded and built from source using an environment with golang 1.21+ installed. After a successful build, the binary can be moved to a location on your operating system PATH.
+The project can be downloaded and built from source using an environment with Go 1.21+ installed. After a successful build, the binary can be moved to a location on your operating system PATH.
 
-### MacOS
+### macOS
 #### Build
 ```
 CGO_ENABLED=0 \

diff --git a/pkg/finder/finder_test.go b/pkg/finder/finder_test.go
@@ -206,7 +206,7 @@ func Test_FileSystemFinderAbsPath(t *testing.T) {
 	}
 }
 
-func Test_FileSystemFinderUpperCaseExtention(t *testing.T) {
+func Test_FileSystemFinderUpperCaseExtension(t *testing.T) {
 	fsFinder := FileSystemFinderInit(
 		WithPathRoots("../../test/fixtures/uppercase-extention"),
 	)
@@ -222,7 +222,7 @@ func Test_FileSystemFinderUpperCaseExtention(t *testing.T) {
 	}
 }
 
-func Test_FileSystemFinderMixedCaseExtention(t *testing.T) {
+func Test_FileSystemFinderMixedCaseExtension(t *testing.T) {
 	fsFinder := FileSystemFinderInit(
 		WithPathRoots("../../test/fixtures/mixedcase-extention"),
 	)