chore: fix typos (#2940)

* docs: typos

* fix: typos

Author: NathanBaulch

.github/workflows/ci-test-go.yml

@@ -120,7 +120,7 @@ jobs:
       - name: go test
         # only run tests on linux, there are a number of things that won't allow the tests to run on anything else
         # many (maybe, all?) images used can only be build on Linux, they don't have Windows in their manifest, and
-        # we can't put Windows Server in "Linux Mode" in Github actions
+        # we can't put Windows Server in "Linux Mode" in GitHub actions
         # another, host mode is only available on Linux, and we have tests around that, do we skip them?
         if: ${{ inputs.run-tests }}
         working-directory: ./${{ inputs.project-directory }}

.github/workflows/conventions.yml

@@ -22,7 +22,7 @@ jobs:
         with:
           # We may not need a scope on every commit (i.e. repo-level change).
           #
-          # feat!: read config consistenly
+          # feat!: read config consistently
           # feat(redis): support for clustering
           # chore(redis): update tests
           # fix(redis): trim connection string

cleanup.go

@@ -107,7 +107,7 @@ func TerminateContainer(container Container, options ...TerminateOption) error {
 	return nil
 }
 
-// isNil returns true if val is nil or an nil instance false otherwise.
+// isNil returns true if val is nil or a nil instance false otherwise.
 func isNil(val any) bool {
 	if val == nil {
 		return true

container.go

@@ -79,7 +79,7 @@ type ImageBuildInfo interface {
 	GetTag() string                                 // get tag label for image
 	BuildLogWriter() io.Writer                      // for output of build log, use io.Discard to disable the output
 	ShouldBuildImage() bool                         // return true if the image needs to be built
-	GetBuildArgs() map[string]*string               // return the environment args used to build the from Dockerfile
+	GetBuildArgs() map[string]*string               // return the environment args used to build the Dockerfile
 	GetAuthConfigs() map[string]registry.AuthConfig // Deprecated. Testcontainers will detect registry credentials automatically. Return the auth configs to be able to pull from an authenticated docker registry
 }
 

docker.go

@@ -618,7 +618,7 @@ func (c *DockerContainer) CopyDirToContainer(ctx context.Context, hostDirPath st
 	}
 
 	if !dir {
-		// it's not a dir: let the consumer to handle an error
+		// it's not a dir: let the consumer handle the error
 		return fmt.Errorf("path %s is not a directory", hostDirPath)
 	}
 

docker_auth_test.go

@@ -493,7 +493,7 @@ func requireValidAuthConfig(t *testing.T) {
 	require.NoError(t, err)
 
 	// We can only check the keys as the values are not deterministic as they depend
-	// on users environment.
+	// on user's environment.
 	expected := map[string]registry.AuthConfig{
 		core.IndexDockerIO: {},
 		exampleRegistry:    {},

docker_test.go

@@ -1391,7 +1391,7 @@ func TestDockerContainerCopyDirToContainer(t *testing.T) {
 	CleanupContainer(t, nginxC)
 	require.NoError(t, err)
 
-	p := filepath.Join(".", "testdata", "Dokerfile")
+	p := filepath.Join(".", "testdata", "Dockerfile")
 	err = nginxC.CopyDirToContainer(ctx, p, "/tmp/testdata/Dockerfile", 700)
 	require.Error(t, err) // copying a file using the directory method will raise an error
 
@@ -1870,7 +1870,7 @@ func assertExtractedFiles(t *testing.T, ctx context.Context, container Container
 		}
 
 		fp := filepath.Join(containerFilePath, srcFile.Name())
-		// copy file by file, as there is a limitation in the Docker client to copy an entiry directory from the container
+		// copy file by file, as there is a limitation in the Docker client to copy an entire directory from the container
 		// paths for the container files are using Linux path separators
 		fd, err := container.CopyFileFromContainer(ctx, fp)
 		require.NoError(t, err, "Path not found in container: %s", fp)

docs/contributing.md

@@ -4,7 +4,7 @@
 
 There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code for the core library or for a technology module.
 
-In any case, if you like the project, please star the project on [Github](https://github.com/testcontainers/testcontainers-go/stargazers) and help spread the word :)
+In any case, if you like the project, please star the project on [GitHub](https://github.com/testcontainers/testcontainers-go/stargazers) and help spread the word :)
 Also join our [Slack workspace](http://slack.testcontainers.org) to get help, share your ideas, and chat with the community.
 
 ## Questions
@@ -49,7 +49,7 @@ Please just be sure to:
     * For linting just the modulegen: `make -C modulegen lint`
 * verify all tests are passing. Build and test the project with `make test-all` to do this.
     * For a given module or example, go to the module or example directory and run `make test`.
-    * If you find an `ld warning` message on MacOS, you can ignore it. It is a indeed a warning: https://github.com/golang/go/issues/61229
+    * If you find an `ld warning` message on MacOS, you can ignore it. It is indeed a warning: https://github.com/golang/go/issues/61229
 > === Errors
 > ld: warning: '/private/var/folders/3y/8hbf585d4yl6f8j5yzqx6wz80000gn/T/go-link-2319589277/000018.o' has malformed LC_DYSYMTAB, expected 98 undefined symbols to start at index 1626, found 95 undefined symbols starting at index 1626
 
@@ -102,4 +102,4 @@ make clean-docs
 Note that documentation for pull requests will automatically be published by Netlify as 'deploy previews'.
 These deployment previews can be accessed via the `deploy/netlify` check that appears for each pull request.
 
-Please check the Github comment Netlify posts on the PR for the URL to the deployment preview.
+Please check the GitHub comment Netlify posts on the PR for the URL to the deployment preview.

docs/features/common_functional_options.md

@@ -6,7 +6,7 @@ In more locked down / secured environments, it can be problematic to pull images
 
 An image name substitutor converts a Docker image name, as may be specified in code, to an alternative name. This is intended to provide a way to override image names, for example to enforce pulling of images from a private registry.
 
-_Testcontainers for Go_ exposes an interface to perform this operations: `ImageSubstitutor`, and a No-operation implementation to be used as reference for custom implementations:
+_Testcontainers for Go_ exposes an interface to perform this operation: `ImageSubstitutor`, and a No-operation implementation to be used as reference for custom implementations:
 
 <!--codeinclude-->
 [Image Substitutor Interface](../../options.go) inside_block:imageSubstitutor

docs/features/creating_container.md

@@ -143,7 +143,7 @@ In the following example, we are going to create a container using all the lifec
 _Testcontainers for Go_ comes with a default logging hook that will print a log message for each container lifecycle event, using the default logger. You can add your own logger by passing the `testcontainers.DefaultLoggingHook` option to the `ContainerRequest`, passing a reference to your preferred logger:
 
 <!--codeinclude-->
-[Use a custom logger for container hooks](../../lifecycle_test.go) inside_block:reqWithDefaultLogginHook
+[Use a custom logger for container hooks](../../lifecycle_test.go) inside_block:reqWithDefaultLoggingHook
 [Custom Logger implementation](../../lifecycle_test.go) inside_block:customLoggerImplementation
 <!--/codeinclude-->
 
@@ -156,7 +156,7 @@ The aforementioned `GenericContainer` function and the `ContainerRequest` struct
 <!--/codeinclude-->
 
 !!!warning
-	The only special case where the modifiers are not applied last, is when there are no exposed ports in the container request and the container does not use a network mode from a container (e.g. `req.NetworkMode = container.NetworkMode("container:$CONTAINER_ID")`). In that case, _Testcontainers for Go_ will extract the ports from the underliying Docker image and export them.
+	The only special case where the modifiers are not applied last, is when there are no exposed ports in the container request and the container does not use a network mode from a container (e.g. `req.NetworkMode = container.NetworkMode("container:$CONTAINER_ID")`). In that case, _Testcontainers for Go_ will extract the ports from the underlying Docker image and export them.
 
 ## Reusable container