Merge pull request #8 from SomeRandomiOSDev/CodacyFixes

Fixed up Codacy issues

Author: SomeRandomiOSDev

.github/CODE_OF_CONDUCT.md

@@ -20,21 +20,16 @@ community include:
 * Demonstrating empathy and kindness toward other people
 * Being respectful of differing opinions, viewpoints, and experiences
 * Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-  community
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
 * Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Enforcement Responsibilities
 
@@ -114,19 +109,12 @@ community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
 
 Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
 For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING.md

@@ -8,13 +8,13 @@ There are three main ways in which you contribute:
 
 1. Open a [Bug Report](https://github.com/SomeRandomiOSDev/KeyValueObservation/issues/new?assignees=SomeRandomiOSDev&labels=bug&template=BUG_REPORT.yml&title=%5BBUG%5D%3A+).
 2. Open a [Feature Request](https://github.com/SomeRandomiOSDev/KeyValueObservation/issues/new?assignees=SomeRandomiOSDev&labels=enhancement&template=FEATURE_REQUEST.yml&title=%5BFEATURE%5D%3A+).
-3. Create a [Pull Request](https://github.com/SomeRandomiOSDev/KeyValueObservation/compare/main...main?expand=1&template=PULL_REQUEST_TEMPLATE.md).
+3. Create a [Pull Request](https://github.com/SomeRandomiOSDev/KeyValueObservation/compare).
 
 > If none of these really suit your needs, you could also open a [blank issue](https://github.com/SomeRandomiOSDev/KeyValueObservation/issues/new).
 
 If you need further guidance or have additional questions, you can always reach out at
 
-- [email protected]
+* [email protected]
 
 Please also note we have a [code of conduct](#code-of-conduct), please follow it in all your interactions with the project.
 
@@ -26,15 +26,16 @@ For contributing via *Bug Reports* or *Feature Requests* contribuing is as simpl
 
 For contributing via *Pull Requests*, we ask the following of you prior to opening a `pull request` to help maintain code standards and quality (many of these are enforced with workflows, but who wants to push subsequent commits for a single PR?):
 
-- Please try and follow the implicit code conventions and naming schemes present within the project.
-- The builds for all platforms should succeed, along with all of the unit tests for each platform.
-- Any new code added should be accompanied by appropriate unit test code to cover (virtually) all cases and paths through that code. The code coverage for this project shouldn't decrease by a significant amount, but increases in code coverage are always welcome and appreciated.
-- Any new public APIs added should be accompanied by documentation in code, and as appropriate, in the [README](../README.md) file and in the Documentation Catalog.
-- Since this project is available via [CocoaPods](https://cocoapods.org), it should lint successfully for both `pod lib lint` and `pod lib lint --use-libraries` using the latest version of the `pod` utility.
+* Please try and follow the implicit code conventions and naming schemes present within the project.
+* All Swift files for this project lint successfully. The latest version of SwiftLint should be used for linting.
+* The builds for all platforms should succeed, along with all of the unit tests for each platform.
+* Any new code added should be accompanied by appropriate unit test code to cover (virtually) all cases and paths through that code. The code coverage for this project shouldn't decrease by a significant amount, but increases in code coverage are always welcome and appreciated.
+* Any new public APIs added should be accompanied by documentation in code, and as appropriate, in the [README](../README.md) file and in the Documentation Catalog.
+* Since this project is available via [CocoaPods](https://cocoapods.org), it should lint successfully for both `pod lib lint` and `pod lib lint --use-libraries` using the latest version of the `pod` utility.
 
 > Tip: It's strongly recommended to use the [workflowtests.sh](../scripts/workflowtests.sh) script for testing all of the various builds & linting as this script is a mirror of the workflows that are ran for `pull requests`.
 
-For further guidance about requirements for `pull requests`, please see the [Pull Request Guidelines](PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md) document.
+For further guidance about requirements for `pull requests`, please see the [Pull Request Guidelines](PULL_REQUEST_TEMPLATE.md) document.
 
 ## Code of Conduct
 

.github/CONTRIBUTORS.md

@@ -1,6 +1,6 @@
 # Contributors
 
-## Special thanks for all the people who have contributed this project so far:
+## Special thanks for all the people who have contributed this project so far
 
 I would like to give a special thanks to all of the people below who have contributed to this project and to all of those who will contribute to it moving forward.
 

.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md renamed to .github/PULL_REQUEST_TEMPLATE.md

@@ -12,13 +12,14 @@ A brief description of your `pull request`.
 
 Ensure that your `pull request` has followed all the steps below:
 
-- [ ] Code compilation.
-- [ ] All tests passing.
-- [ ] Added new unit tests, if applicable.
-- [ ] Extended the documentation (including README), if applicable.
-- [ ] Updated version in KeyValueObservation.podspec following [semver](https://semver.org) guidelines.
-- [ ] Ran [workflowtests.sh](../../scripts/workflowtests.sh) and passed.
-- [ ] Added myself to the [CONTRIBUTORS](../CONTRIBUTORS.md) file.
+* [ ] Code compilation.
+* [ ] All tests passing.
+* [ ] No new SwiftLint issues.
+* [ ] Added new unit tests, if applicable.
+* [ ] Extended the documentation (including README), if applicable.
+* [ ] Updated version in KeyValueObservation.podspec following [semver](https://semver.org) guidelines.
+* [ ] Ran [workflowtests.sh](../../scripts/workflowtests.sh) and passed.
+* [ ] Added myself to the [CONTRIBUTORS](../CONTRIBUTORS.md) file.
 
 ## Proposed changes
 

.github/workflows/carthage.yml

@@ -10,6 +10,7 @@ on:
       - '.github/**' # Ignore all files under '.github'
       - '!.github/workflows/carthage.yml' # Except for this workflow
       - '.gitignore'
+      - '.remarkrc'
       - 'codecov.yml'
       - 'KeyValueObservation.podspec'
       - 'LICENSE'

.github/workflows/cocoapods.yml

@@ -10,6 +10,7 @@ on:
       - '.github/**' # Ignore all files under '.github'
       - '!.github/workflows/cocoapods.yml' # Except for this workflow
       - '.gitignore'
+      - '.remarkrc'
       - 'codecov.yml'
       - 'LICENSE'
       - 'README.md'

.github/workflows/xcframework.yml

@@ -10,6 +10,7 @@ on:
       - '.github/**' # Ignore all files under '.github'
       - '!.github/workflows/xcframework.yml' # Except for this workflow
       - '.gitignore'
+      - '.remarkrc'
       - 'codecov.yml'
       - 'KeyValueObservation.podspec'
       - 'LICENSE'

.github/workflows/xcodebuild.yml

@@ -10,6 +10,7 @@ on:
       - '.github/**' # Ignore all files under '.github'
       - '!.github/workflows/xcodebuild.yml' # Except for this workflow
       - '.gitignore'
+      - '.remarkrc'
       - 'KeyValueObservation.podspec'
       - 'LICENSE'
       - 'README.md'

.remarkrc

@@ -0,0 +1,9 @@
+{
+  "plugins": [
+    "remark-preset-lint-recommended",
+    ["remark-lint-list-item-indent", "space"],
+    ["remark-lint-no-undefined-references", {"allow": [" ", "x", "X"]}],
+    ["remark-lint-no-file-name-irregular-characters", "\\.a-zA-Z0-9-_"],
+    ["remark-lint-no-heading-punctuation", ".,;:"]
+  ]
+}