Browse Source

Use welcoming language (#178)

Yim Lee 4 years ago
parent
commit
c6437b76d8
3 changed files with 24 additions and 8 deletions
  1. 5 5
      CONTRIBUTING.md
  2. 2 2
      docker/docker-compose.yaml
  3. 17 1
      scripts/soundness.sh

+ 5 - 5
CONTRIBUTING.md

@@ -65,12 +65,12 @@ We require that your commit messages match our template. The easiest way to do t
 SwiftLog uses XCTest to run tests on both macOS and Linux. While the macOS version of XCTest is able to use the Objective-C runtime to discover tests at execution time, the Linux version is not.
 For this reason, whenever you add new tests **you have to run a script** that generates the hooks needed to run those tests on Linux, or our CI will complain that the tests are not all present on Linux. To do this, merely execute `ruby ./scripts/generate_linux_tests.rb` at the root of the package and check the changes it made.
 
-### Run `./scripts/sanity.sh`
+### Run `./scripts/soundness.sh`
 
-The scripts directory contains a [sanity.sh script](https://github.com/apple/swift-log/blob/main/scripts/sanity.sh) 
+The scripts directory contains a [soundness.sh script](https://github.com/apple/swift-log/blob/main/scripts/soundness.sh) 
 that enforces additional checks, like license headers and formatting style.
 
-Please make sure to `./scripts/sanity.sh` before pushing a change upstream, otherwise it is likely the PR validation will fail
+Please make sure to `./scripts/soundness.sh` before pushing a change upstream, otherwise it is likely the PR validation will fail
 on minor changes such as a missing `self.` or similar formatting issues.
 
 > The script also executes the above mentioned `generate_linux_tests.rb`.
@@ -81,8 +81,8 @@ For frequent contributors, we recommend adding the script as a [git pre-push hoo
 cat << EOF > .git/hooks/pre-push
 #!/bin/bash
 
-if [[ -f "scripts/sanity.sh" ]]; then
-  scripts/sanity.sh
+if [[ -f "scripts/soundness.sh" ]]; then
+  scripts/soundness.sh
 fi
 EOF
 ```

+ 2 - 2
docker/docker-compose.yaml

@@ -22,9 +22,9 @@ services:
       - CAP_NET_RAW
       - CAP_NET_BIND_SERVICE
 
-  sanity:
+  soundness:
     <<: *common
-    command: /bin/bash -xcl "./scripts/sanity.sh"
+    command: /bin/bash -xcl "./scripts/soundness.sh"
 
   test:
     <<: *common

+ 17 - 1
scripts/sanity.sh → scripts/soundness.sh

@@ -47,6 +47,22 @@ else
   printf "\033[0;32mokay.\033[0m\n"
 fi
 
+printf "=> Checking for unacceptable language... "
+# This greps for unacceptable terminology. The square bracket[s] are so that
+# "git grep" doesn't find the lines that greps :).
+unacceptable_terms=(
+    -e blacklis[t]
+    -e whitelis[t]
+    -e slav[e]
+    -e sanit[y]
+)
+if git grep --color=never -i "${unacceptable_terms[@]}" > /dev/null; then
+    printf "\033[0;31mUnacceptable language found.\033[0m\n"
+    git grep -i "${unacceptable_terms[@]}"
+    exit 1
+fi
+printf "\033[0;32mokay.\033[0m\n"
+
 printf "=> Checking format... "
 FIRST_OUT="$(git status --porcelain)"
 swiftformat . > /dev/null 2>&1
@@ -60,7 +76,7 @@ else
 fi
 
 printf "=> Checking license headers\n"
-tmp=$(mktemp /tmp/.swift-log-sanity_XXXXXX)
+tmp=$(mktemp /tmp/.swift-log-soundness_XXXXXX)
 
 for language in swift-or-c bash dtrace; do
   printf "   * $language... "