diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 22e8df07..265235c0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -104,7 +104,7 @@ Please try to keep your individual changes as minimal and focussed on the issue If you discover that the scope of your contribution is growing larger than expected you might want to split the changes into multiple separate contributions to allow a more focussed discussion and review. It is usually a great idea and often required to add tests for your changes. -This allows us to quickly validate that the changes are working as intended and also guarantees that they wont be broken by other future updates. +This allows us to quickly validate that the changes are working as intended and also guarantees that they won't be broken by other future updates. For small and targeted functional changes, e.g. supporting a new URL schema, a [unit test](#unit-tests) may be enough. For contributions that change large-scale behaviour, such as dependency caching features, an [integration test](#integration-tests) is more suited. Depending on the changes, a combination of both test types may also be appropriate. @@ -174,4 +174,4 @@ cmake --build build/style --target fix-format ## Attribution -This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)! \ No newline at end of file +This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)! diff --git a/README.md b/README.md index 43acc3a5..3d9aa0c7 100644 --- a/README.md +++ b/README.md @@ -409,7 +409,7 @@ CPMAddPackage( ### [Boost](https://github.com/boostorg/boost) Boost is a large project and will take a while to download. Using -`CPM_SOURCE_CACHE` is strongly recomended. Cloning moves much more +`CPM_SOURCE_CACHE` is strongly recommended. Cloning moves much more data than a source archive, so this sample will use a compressed source archive (tar.xz) release from Boost's github page. @@ -538,7 +538,7 @@ The URL for branch `v2.x` of spdlog is: #### Tag -Tags are simiar, but with this format: +Tags are similar, but with this format: `https://github.com///archive/refs/tags/.` @@ -561,7 +561,7 @@ Example: ### Determining the Hash -The following snipet illustrates determining the SHA256 hash on a linux machine using `wget` and `sha256sum`: +The following snippet illustrates determining the SHA256 hash on a linux machine using `wget` and `sha256sum`: ```bash wget https://github.com/gabime/spdlog/archive/refs/tags/v1.13.0.zip -O - | sha256sum ``` diff --git a/test/integration/test_simple.rb b/test/integration/test_simple.rb index a63eb6d4..33fe3785 100644 --- a/test/integration/test_simple.rb +++ b/test/integration/test_simple.rb @@ -70,7 +70,7 @@ def test_update_single_package exes = Dir[exe_dir + '/**/*'].filter { # on multi-configuration generators (like Visual Studio) the executables will be in bin/ - # also filter-out other articacts like .pdb or .dsym + # also filter-out other artifacts like .pdb or .dsym !File.directory?(_1) && File.stat(_1).executable? }.map { # remove .exe extension if any (there will be one on Windows)