Skip to content

Commit 27d939d

Browse files
committed
Fix markdown linter warnings
1 parent 0717789 commit 27d939d

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ This is a template for creating iOS projects at Q42. It has opinionated defaults
1313

1414
Only basic features that almost all projects use, were added in this template:
1515

16-
* SwiftUI using the SwiftUI lifecycle with an AppDelegate
17-
* Implementation of the Clean Architecture
18-
* Dependency injection using the library Factory
19-
* Unit tests and UI tests using Salad
20-
* GitHub Actions CI configuration that runs the tests and submits the app to TestFlight
16+
- SwiftUI using the SwiftUI lifecycle with an AppDelegate
17+
- Implementation of the Clean Architecture
18+
- Dependency injection using the library Factory
19+
- Unit tests and UI tests using Salad
20+
- GitHub Actions CI configuration that runs the tests and submits the app to TestFlight
2121

2222
Xcode 26 or higher is required.
2323

@@ -74,47 +74,47 @@ We use [Factory](https://github.com/hmlongco/Factory) as a DI container.
7474

7575
### Modules & libraries
7676

77-
* Preferably use the Swift Package Manager for dependencies. Use other package managers only if there's no other option.
78-
* Only extract code into a package if there are strong reasons to do so. For example:
79-
* It is used from at least two different targets/packages, or is a candidate to be extracted to an open-source package.
80-
* It is completely self-contained.
77+
- Preferably use the Swift Package Manager for dependencies. Use other package managers only if there's no other option.
78+
- Only extract code into a package if there are strong reasons to do so. For example:
79+
- It is used from at least two different targets/packages, or is a candidate to be extracted to an open-source package.
80+
- It is completely self-contained.
8181

8282
When choosing a third-party library, prefer libraries that:
8383

84-
* Are written in idiomatic Swift or Objective-C that sticks to best practices.
85-
* Have as few dependencies of its own as possible. Preferably none.
86-
* Aren't too big, in order to keep compile times and bloat in check.
84+
- Are written in idiomatic Swift or Objective-C that sticks to best practices.
85+
- Have as few dependencies of its own as possible. Preferably none.
86+
- Aren't too big, in order to keep compile times and bloat in check.
8787

8888
### Testing
8989

90-
* For business logic, we write unit tests.
91-
* For testing the user interface, we write UI tests in a behaviour-driven way using the [Salad](https://github.com/Q42/Salad) library.
92-
* Tests are run on CI (GitHub Actions). Tests must pass before a PR may be merged and before any sort of build is created.
90+
- For business logic, we write unit tests.
91+
- For testing the user interface, we write UI tests in a behaviour-driven way using the [Salad](https://github.com/Q42/Salad) library.
92+
- Tests are run on CI (GitHub Actions). Tests must pass before a PR may be merged and before any sort of build is created.
9393

9494
### Views
9595

96-
* Keep views focused (single-responsibility principle from SOLID). When a view becomes large a, split it up into smaller views.
97-
* Every view gets a UI preview if at all possible. The preview should show the view in different states using dummy data.
98-
* We use [custom SF Symbols](https://developer.apple.com/documentation/uikit/uiimage/creating_custom_symbol_images_for_your_app/) whenever a custom icon is needed, so that they render in a consistent manner.
96+
- Keep views focused (single-responsibility principle from SOLID). When a view becomes large a, split it up into smaller views.
97+
- Every view gets a UI preview if at all possible. The preview should show the view in different states using dummy data.
98+
- We use [custom SF Symbols](https://developer.apple.com/documentation/uikit/uiimage/creating_custom_symbol_images_for_your_app/) whenever a custom icon is needed, so that they render in a consistent manner.
9999

100100
### Accessibility
101101

102-
* Every new component or control should be audited for basic accessibility support:
103-
* Dynamic type size support
104-
* VoiceOver support
105-
* Also consider:
106-
* Bold text support
107-
* High contrast support
108-
* Use `accessibilityRepresentation` on custom controls to make them accessible.
102+
- Every new component or control should be audited for basic accessibility support:
103+
- Dynamic type size support
104+
- VoiceOver support
105+
- Also consider:
106+
- Bold text support
107+
- High contrast support
108+
- Use `accessibilityRepresentation` on custom controls to make them accessible.
109109

110110
### Localization
111111

112112
String catalogs are used to localize the project. The default languages supported are English and Dutch.
113113

114114
### Async code
115115

116-
* `async`/`await` is preferred over Combine/Promises/etc. to leverage the compiler concurrency checking.
117-
* [Combine](https://developer.apple.com/documentation/combine) can be used when `async`/`await` or `AsyncSequence` fall short, and more complexity is needed to solve the problem at hand.
116+
- `async`/`await` is preferred over Combine/Promises/etc. to leverage the compiler concurrency checking.
117+
- [Combine](https://developer.apple.com/documentation/combine) can be used when `async`/`await` or `AsyncSequence` fall short, and more complexity is needed to solve the problem at hand.
118118

119119
## Continuous integration
120120

@@ -126,11 +126,11 @@ On a push to the `main` branch, it will also run the tests, and if they pass, a
126126
Five environment secrets are needed for the workflow to run on GitHub Actions.
127127
You may configure these in the repository secret settings on GitHub.
128128

129-
* `BUILD_CERTIFICATE_BASE64` contains a base64-encoded string of the .p12 certificate bundle, used to code sign the app. This bundle needs to contain two certificates: **development** and **distribution**.
130-
* `P12_PASSWORD` contains the password of the certificate bundle.
131-
* `APP_STORE_CONNECT_API_KEY_BASE64` contains a base64-encoded string of the .p8 App Store Connect API key.
132-
* `APP_STORE_CONNECT_API_KEY_ID` contains the key ID of the App Store Connect API key.
133-
* `APP_STORE_CONNECT_API_KEY_ISSUER_ID` contains the issuer ID of the App Store Connect API key.
129+
- `BUILD_CERTIFICATE_BASE64` contains a base64-encoded string of the .p12 certificate bundle, used to code sign the app. This bundle needs to contain two certificates: **development** and **distribution**.
130+
- `P12_PASSWORD` contains the password of the certificate bundle.
131+
- `APP_STORE_CONNECT_API_KEY_BASE64` contains a base64-encoded string of the .p8 App Store Connect API key.
132+
- `APP_STORE_CONNECT_API_KEY_ID` contains the key ID of the App Store Connect API key.
133+
- `APP_STORE_CONNECT_API_KEY_ISSUER_ID` contains the issuer ID of the App Store Connect API key.
134134

135135
To create such a certificate bundle, open Keychain Access. Unfold the entries for the development and distribution certificate. Select the certificates and their private keys using shift, then right-click and select "Export 4 items...".
136136

0 commit comments

Comments
 (0)