Add files to comply with community standards (#2)

ns-vasilev · web-flow · commit 116edecea780 · 2024-01-31T16:25:09.000+01:00
* Update comments

* Add files to comply with community standards

* Update `CHANGELOG.md`

* Fix typos

* Update the `Ruby` version from `2.7` to `3.1.4`
diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_template.md b/.github/PULL_REQUEST_TEMPLATE/bug_template.md
diff --git a/.github/PULL_REQUEST_TEMPLATE/feature_template.md b/.github/PULL_REQUEST_TEMPLATE/feature_template.md
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -24,21 +24,39 @@ jobs:
           args: --strict
         env:
           DIFF_BASE: ${{ github.base_ref }}
-  Latest:
-    name: Test Latest (iOS)
-    runs-on: macOS-12
+  iOS:
+    name: ${{ matrix.name }}
+    runs-on: ${{ matrix.runsOn }}
     env:
-      DEVELOPER_DIR: "/Applications/Xcode_14.1.app/Contents/Developer"
-    timeout-minutes: 10
+      DEVELOPER_DIR: "/Applications/${{ matrix.xcode }}.app/Contents/Developer"
+    timeout-minutes: 20
     strategy:
       fail-fast: false
       matrix:
         include:
-          - destination: "OS=16.1,name=iPhone 14 Pro"
-            name: "iOS"
-            scheme: "HapticFeedback"
+          - destination: "OS=17.0.1,name=iPhone 14 Pro"
+            name: "iOS 17.0.1"
+            xcode: "Xcode_15.0"
+            runsOn: macos-13
+          - destination: "OS=16.4,name=iPhone 14 Pro"
+            name: "iOS 16.4"
+            xcode: "Xcode_14.3.1"
+            runsOn: macos-13
     steps:
       - uses: actions/checkout@v3
       - name: ${{ matrix.name }}
-        run: xcodebuild -scheme "${{ matrix.scheme }}" -destination "${{ matrix.destination }}" clean
-      
+        run: xcodebuild -scheme "HapticFeedback" -destination "${{ matrix.destination }}" clean || exit 1
+
+  discover-typos:
+    name: Discover Typos
+    runs-on: macOS-12
+    env:
+      DEVELOPER_DIR: /Applications/Xcode_14.1.app/Contents/Developer
+    steps:
+      - uses: actions/checkout@v2
+      - name: Discover typos
+        run: |
+          export PATH="$PATH:/Library/Frameworks/Python.framework/Versions/3.11/bin"
+          python3 -m pip install --upgrade pip
+          python3 -m pip install codespell
+          codespell --ignore-words-list="hart,inout,msdos,sur" --skip="./.build/*,./.git/*"
diff --git a/.github/workflows/danger.yml b/.github/workflows/danger.yml
@@ -15,7 +15,7 @@ jobs:
       - name: ruby setup
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.1.4
           bundler-cache: true
       - name: Checkout code
         uses: actions/checkout@v2
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -1,6 +1,8 @@
 excluded:
   - Tests
   - Package.swift
+  - Package@swift-5.7.swift
+  - Package@swift-5.8.swift
   - .build
 
 # Rules
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,14 @@
 All notable changes to this project will be documented in this file.
 
 #### 1.x Releases
-- `1.0.x` Releases - [1.0.0](#100)
+- `1.0.x` Releases - [1.0.0](#100) | [1.0.1](#101)
+
+## [1.0.1](https://github.com/space-code/haptic-feedback/releases/tag/1.0.1)
+Released on 2024-01-31.
+
+#### Added
+- Add files to comply with community standards
+  - Added in Pull Request [#2](https://github.com/space-code/haptic-feedback/pull/2)
 
 ## [1.0.0](https://github.com/space-code/haptic-feedback/releases/tag/1.0.0)
 Released on 2023-11-26.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting one of the project maintainers https://github.com/orgs/space-code/people. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,61 @@
+# Contributing Guidelines
+
+This document contains information and guidelines about contributing to this project.
+Please read it before you start participating.
+
+**Topics**
+
+* [Reporting Issues](#reporting-issues)
+* [Submitting Pull Requests](#submitting-pull-requests)
+* [Developers Certificate of Origin](#developers-certificate-of-origin)
+* [Code of Conduct](#code-of-conduct)
+
+## Reporting Issues
+
+A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report.
+
+Check that the project issues database doesn't already include that problem or suggestion before submitting an issue. If you find a match, feel free to vote for the issue by adding a reaction. Doing this helps prioritize the most common problems and requests.
+
+When reporting issues, please fill out our issue template. The information the template asks for will help us review and fix your issue faster.
+
+## Submitting Pull Requests
+
+You can contribute by fixing bugs or adding new features. For larger code changes, we recommend first discussing your ideas on our [GitHub Discussions](https://github.com/space-code/haptic-feedback/discussions). When submitting a pull request, please add relevant tests and ensure your changes don't break any existing tests.
+
+## Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+- (a) The contribution was created in whole or in part by me and I
+      have the right to submit it under the open source license
+      indicated in the file; or
+
+- (b) The contribution is based upon previous work that, to the best
+      of my knowledge, is covered under an appropriate open source
+      license and I have the right under that license to submit that
+      work with modifications, whether created in whole or in part
+      by me, under the same open source license (unless I am
+      permitted to submit under a different license), as indicated
+      in the file; or
+
+- (c) The contribution was provided directly to me by some other
+      person who certified (a), (b) or (c) and I have not modified
+      it.
+
+- (d) I understand and agree that this project and the contribution
+      are public and that a record of the contribution (including all
+      personal information I submit with it, including my sign-off) is
+      maintained indefinitely and may be redistributed consistent with
+      this project or the open source license(s) involved.
+
+## Code of Conduct
+
+The Code of Conduct governs how we behave in public or in private
+whenever the project will be judged by our actions.
+We expect it to be honored by everyone who contributes to this project.
+
+See [CODE_OF_CONDUCT.md](https://github.com/space-code/haptic-feedback/blob/master/CODE_OF_CONDUCT.md) for details.
+
+---
+
+*Some of the ideas and wording for the statements above were based on work by the [Docker](https://github.com/docker/docker/blob/master/CONTRIBUTING.md) and [Linux](https://elinux.org/Developer_Certificate_Of_Origin) communities.
diff --git a/Package.swift b/Package.swift
@@ -1,4 +1,4 @@
-// swift-tools-version: 5.7
+// swift-tools-version: 5.9
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
diff --git a/Package@swift-5.7.swift b/Package@swift-5.7.swift
@@ -0,0 +1,18 @@
+// swift-tools-version: 5.7
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "HapticFeedback",
+    platforms: [
+        .iOS(.v11),
+    ],
+    products: [
+        .library(name: "HapticFeedback", targets: ["HapticFeedback"]),
+    ],
+    dependencies: [],
+    targets: [
+        .target(name: "HapticFeedback", dependencies: []),
+    ]
+)
diff --git a/Package@swift-5.8.swift b/Package@swift-5.8.swift
@@ -0,0 +1,18 @@
+// swift-tools-version: 5.8
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "HapticFeedback",
+    platforms: [
+        .iOS(.v11),
+    ],
+    products: [
+        .library(name: "HapticFeedback", targets: ["HapticFeedback"]),
+    ],
+    dependencies: [],
+    targets: [
+        .target(name: "HapticFeedback", dependencies: []),
+    ]
+)
diff --git a/README.md b/README.md
@@ -4,8 +4,8 @@
 
 <p align="center">
 <a href="https://github.com/space-code/haptic-feedback/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/space-code/haptic-feedback?style=flat"></a> 
-<a href="https://swiftpackageindex.com/space-code/haptic-feedback"><img alt="Swift Compability" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fspace-code%2Fhaptic-feedback%2Fbadge%3Ftype%3Dswift-versions"/></a> 
-<a href="https://swiftpackageindex.com/space-code/haptic-feedback"><img alt="Platform Compability" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fspace-code%2Fhaptic-feedback%2Fbadge%3Ftype%3Dplatforms"/></a> 
+<a href="https://swiftpackageindex.com/space-code/haptic-feedback"><img alt="Swift Compatibility" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fspace-code%2Fhaptic-feedback%2Fbadge%3Ftype%3Dswift-versions"/></a> 
+<a href="https://swiftpackageindex.com/space-code/haptic-feedback"><img alt="Platform Compatibility" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fspace-code%2Fhaptic-feedback%2Fbadge%3Ftype%3Dplatforms"/></a> 
 <a href="https://github.com/space-code/haptic-feedback"><img alt="CI" src="https://github.com/space-code/haptic-feedback/actions/workflows/ci.yml/badge.svg?branch=main"></a>
 <a href="https://github.com/apple/swift-package-manager" alt="haptic-feedback on Swift Package Manager" title="haptic-feedback on Swift Package Manager"><img src="https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg" /></a>
 </p>
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,7 @@
+# Reporting Security Vulnerabilities
+
+This software is built with security and data privacy in mind to ensure your data is safe. We are grateful for security researchers and users reporting a vulnerability to us, first. To ensure that your request is handled in a timely manner and non-disclosure of vulnerabilities can be assured, please follow the below guideline.
+
+**Please do not report security vulnerabilities directly on GitHub. GitHub Issues can be publicly seen and therefore would result in a direct disclosure.**
+
+* Please address questions about data privacy, security concepts, and other media requests to the nv3212@gmail.com mailbox.
diff --git a/Sources/HapticFeedback/Classes/HapticFeedback.swift b/Sources/HapticFeedback/Classes/HapticFeedback.swift
@@ -1,22 +1,22 @@
 //
 // haptic-feedback
-// Copyright © 2023 Space Code. All rights reserved.
+// Copyright © 2024 Space Code. All rights reserved.
 //
 
 import UIKit
 
-// Enum defining different types of haptic feedback
+/// Enum defining different types of haptic feedback
 public enum HapticFeedback: Equatable {
-    // Haptic feedback for impact with a specified style
+    /// Haptic feedback for impact with a specified style
     case impact(UIImpactFeedbackGenerator.FeedbackStyle)
 
-    // Haptic feedback for notifications with a specified type
+    /// Haptic feedback for notifications with a specified type
     case notification(UINotificationFeedbackGenerator.FeedbackType)
 
-    // Haptic feedback for selection
+    /// Haptic feedback for selection
     case selection
 
-    // Function to generate haptic feedback based on the enum case
+    /// Function to generate haptic feedback based on the enum case
     public func generate() {
         switch self {
         case let .impact(style):

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// swift-tools-version: 5.7`
	`1`	`+// swift-tools-version: 5.9`
`2`	`2`	`// The swift-tools-version declares the minimum version of Swift required to build this package.`
`3`	`3`
`4`	`4`	`import PackageDescription`