diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 872227a2..d50e160a 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -8,6 +8,17 @@ body: value: | Thanks for taking the time to fill out this bug report! + - type: checkboxes + id: prerequisites + attributes: + label: Before submitting + description: Please confirm you've completed the following steps + options: + - label: I have searched existing issues to make sure this bug hasn't already been reported + required: true + - label: I have updated to the latest version of the software to verify the issue still exists + required: true + - type: input id: version attributes: diff --git a/.gitignore b/.gitignore index a6d2222f..b4360ace 100644 --- a/.gitignore +++ b/.gitignore @@ -90,3 +90,6 @@ fastlane/test_output # https://github.com/johnno1962/injectionforxcode iOSInjectionProject/ + +# Exclude Package.resolved files +*.resolved diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94ade3d3..60f3057e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,29 +4,31 @@ Thank you for considering contributing to Meshtastic! We appreciate your time an ## Table of Contents -1. [Getting Started](#getting-started) -2. [Development Workflow](#development-workflow) - - [Targeting `main`](#targeting-main) - - [Small, Incremental Changes](#small-incremental-changes) - - [Rebase Commits](#rebase-commits) -3. [Creating a Branch](#creating-a-branch) -4. [Making Changes](#making-changes) -5. [Commit Messages](#commit-messages) -6. [Merging Changes](#merging-changes) -7. [Testing](#testing) -8. [Code Review](#code-review) -9. [Documentation](#documentation) -10. [Style Guides](#style-guides) +- [Contributing to Meshtastic](#contributing-to-meshtastic) + - [Table of Contents](#table-of-contents) + - [Getting Started](#getting-started) + - [Development Workflow](#development-workflow) + - [Targeting `main`](#targeting-main) + - [Small, Incremental Changes](#small-incremental-changes) + - [Rebase Commits](#rebase-commits) + - [Creating a Branch](#creating-a-branch) + - [Making Changes](#making-changes) + - [Commit Messages](#commit-messages) + - [Merging Changes](#merging-changes) + - [Testing](#testing) + - [Code Review](#code-review) + - [Documentation](#documentation) + - [Style Guides](#style-guides) - [Git Commit Messages](#git-commit-messages) - [Code Style](#code-style) -11. [Community](#community) + - [Community](#community) ## Getting Started -1. Fork the repository on GitLab. +1. Fork the repository on GitHub. 2. Clone your fork to your local machine: ```sh - git clone https://gitlab.com//Meshtastic-Apple.git + git clone https://github.com//Meshtastic-Apple.git ``` 3. Navigate to the project directory: ```sh diff --git a/Meshtastic.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/Meshtastic.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved deleted file mode 100644 index d528f985..00000000 --- a/Meshtastic.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved +++ /dev/null @@ -1,51 +0,0 @@ -{ - "originHash" : "2d0b85469585b0d6079eac292d63864096062c24848a49380b9d9727f0ceb96c", - "pins" : [ - { - "identity" : "cocoamqtt", - "kind" : "remoteSourceControl", - "location" : "https://github.com/emqx/CocoaMQTT", - "state" : { - "revision" : "85387a2478551ad84f39be8a3c8587d34dd2bcf5", - "version" : "2.1.5" - } - }, - { - "identity" : "mqttcocoaasyncsocket", - "kind" : "remoteSourceControl", - "location" : "https://github.com/leeway1208/MqttCocoaAsyncSocket", - "state" : { - "revision" : "ce3e18607fd01079495f86ff6195d8a3ca469f73", - "version" : "1.0.8" - } - }, - { - "identity" : "sqlite.swift", - "kind" : "remoteSourceControl", - "location" : "https://github.com/stephencelis/SQLite.swift.git", - "state" : { - "revision" : "7a2e3cd27de56f6d396e84f63beefd0267b55ccb", - "version" : "0.14.1" - } - }, - { - "identity" : "starscream", - "kind" : "remoteSourceControl", - "location" : "https://github.com/daltoniam/Starscream.git", - "state" : { - "revision" : "a063fda2b8145a231953c20e7a646be254365396", - "version" : "3.1.2" - } - }, - { - "identity" : "swift-protobuf", - "kind" : "remoteSourceControl", - "location" : "https://github.com/apple/swift-protobuf.git", - "state" : { - "revision" : "9f0c76544701845ad98716f3f6a774a892152bcb", - "version" : "1.26.0" - } - } - ], - "version" : 3 -} diff --git a/Meshtastic.xcworkspace/xcshareddata/swiftpm/Package.resolved b/Meshtastic.xcworkspace/xcshareddata/swiftpm/Package.resolved deleted file mode 100644 index 3465793d..00000000 --- a/Meshtastic.xcworkspace/xcshareddata/swiftpm/Package.resolved +++ /dev/null @@ -1,51 +0,0 @@ -{ - "originHash" : "1571e0d09fede5d57a2c415019f30868d90fde5a53a863cc277593881c2dc4a5", - "pins" : [ - { - "identity" : "cocoamqtt", - "kind" : "remoteSourceControl", - "location" : "https://github.com/emqx/CocoaMQTT", - "state" : { - "revision" : "aff43422925cc30b9af319f4c4dce4f52859baf4", - "version" : "2.1.8" - } - }, - { - "identity" : "mqttcocoaasyncsocket", - "kind" : "remoteSourceControl", - "location" : "https://github.com/leeway1208/MqttCocoaAsyncSocket", - "state" : { - "revision" : "ce3e18607fd01079495f86ff6195d8a3ca469f73", - "version" : "1.0.8" - } - }, - { - "identity" : "sqlite.swift", - "kind" : "remoteSourceControl", - "location" : "https://github.com/stephencelis/SQLite.swift.git", - "state" : { - "revision" : "a95fc6df17d108bd99210db5e8a9bac90fe984b8", - "version" : "0.15.3" - } - }, - { - "identity" : "starscream", - "kind" : "remoteSourceControl", - "location" : "https://github.com/daltoniam/Starscream.git", - "state" : { - "revision" : "c6bfd1af48efcc9a9ad203665db12375ba6b145a", - "version" : "4.0.8" - } - }, - { - "identity" : "swift-protobuf", - "kind" : "remoteSourceControl", - "location" : "https://github.com/apple/swift-protobuf.git", - "state" : { - "revision" : "edb6ed4919f7756157fe02f2552b7e3850a538e5", - "version" : "1.28.1" - } - } - ], - "version" : 3 -} diff --git a/Meshtastic/Views/Settings/Firmware.swift b/Meshtastic/Views/Settings/Firmware.swift index 76922d54..b0c9c08f 100644 --- a/Meshtastic/Views/Settings/Firmware.swift +++ b/Meshtastic/Views/Settings/Firmware.swift @@ -138,7 +138,7 @@ struct Firmware: View { .font(.callout) .padding(.bottom) } else { - Text("OTA Updates are not supported on the this NRF Device.") + Text("OTA Updates are not supported on this NRF Device.") .font(.title3) Link("Drag & Drop Firmware Update", destination: URL(string: "https://meshtastic.org/docs/getting-started/flashing-firmware/nrf52/drag-n-drop")!) .font(.callout) diff --git a/README.md b/README.md index bbaf49b0..d2ab6c35 100644 --- a/README.md +++ b/README.md @@ -9,16 +9,22 @@ SwiftUI client applications for iOS, iPadOS and macOS. This project always uses the latest release version of XCode. 1. Clone the repo. -2. Set up git hooks to automatically lint the project when you commit changes. -2. Open `Meshtastic.xcworkspace` -2. Build and run the `Meshtastic` target. - -```sh -git clone git@github.com:meshtastic/Meshtastic-Apple.git -cd Meshtastic-Apple -./scripts/setup-hooks.sh -open Meshtastic.xcworkspace -``` + ```sh + git clone git@github.com:meshtastic/Meshtastic-Apple.git + ``` +2. Open the local directory. + ```sh + cd Meshtastic-Apple + ``` +3. Set up git hooks to automatically lint the project when you commit changes. + ```sh + ./scripts/setup-hooks.sh + ``` +4. Open `Meshtastic.xcworkspace` + ```sh + open Meshtastic.xcworkspace + ``` +5. Build and run the `Meshtastic` target. ## Technical Standards