Skip to content

Commit ede35e0

Browse files
committed
Improve some docs
1 parent af0e50c commit ede35e0

3 files changed

Lines changed: 45 additions & 33 deletions

File tree

README.md

Lines changed: 1 addition & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -32,36 +32,4 @@ Verify the setting is **disabled** (the default).
3232

3333
# Contributing
3434

35-
## Running Fastlane
36-
37-
To run tests for a single version,
38-
39-
`bundle exec fastlane test`
40-
41-
To run the release tests, run all the same tests against more than just the latest supported version.
42-
43-
`bundle exec fastlane run_multi_version_tests`
44-
45-
## Code Formatting
46-
Use swiftformat to do this.
47-
48-
`swiftformat --swiftversion 6.0.3 .`
49-
50-
## Local Xcode Config
51-
52-
You're going to probably have your own team ID used in builds/provisioning. You can set that inside `Configs/LocalOverrides.xcconfig`. The contents of that file
53-
should look something like this. Use your ID you see inside the .pbxproj file.
54-
55-
```
56-
DEVELOPMENT_TEAM = AABBCC12345
57-
```
58-
59-
Then to make sure this is included, do this in Xcode:
60-
61-
1. Click on the project.
62-
2. Info > expand the Configuration section > Debug
63-
3. Expand the debug section.
64-
4. All targets are listed. At least set a config file for `SnapSafe` which is the main app local build.
65-
5. In the column called `based on configuration file`, select the file `Configs/Signing.xcconfig`.
66-
67-
That should point to that local config and your value there will override whatever is in the signing or project-level config. This avoids the `.pbxproj` file shenanigans.
35+
Take a look at our [development](docs/DEVELOPMENT.md) docs.

doc/DEVELOPMENT.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Development
2+
3+
## How to release a new version
4+
Read the docs [here](HOW-TO-RELEASE.md)
5+
6+
## Running Fastlane
7+
8+
To run tests for a single version,
9+
10+
`bundle exec fastlane test`
11+
12+
To run the release tests, run all the same tests against more than just the latest supported version.
13+
14+
`bundle exec fastlane run_multi_version_tests`
15+
16+
## Code Formatting
17+
Use swiftformat to do this.
18+
19+
`swiftformat --swiftversion 6.0.3 .`
20+
21+
## Local Xcode Config
22+
23+
You're going to probably have your own team ID used in builds/provisioning. You can set that inside `Configs/LocalOverrides.xcconfig`. The contents of that file
24+
should look something like this. Use your ID you see inside the .pbxproj file.
25+
26+
```
27+
DEVELOPMENT_TEAM = AABBCC12345
28+
```
29+
30+
Then to make sure this is included, do this in Xcode:
31+
32+
1. Click on the project.
33+
2. Info > expand the Configuration section > Debug
34+
3. Expand the debug section.
35+
4. All targets are listed. At least set a config file for `SnapSafe` which is the main app local build.
36+
5. In the column called `based on configuration file`, select the file `Configs/Signing.xcconfig`.
37+
38+
That should point to that local config and your value there will override whatever is in the signing or project-level config. This avoids the `.pbxproj` file shenanigans.

doc/HOW-TO-RELEASE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# How to Release
2+
3+
- In XCode update the app version to a new SemVar value
4+
- Commit and push all changes
5+
- Tag the latest commit using the new SemVar value in the form of "v1.2.3"
6+
- Push the tag, CI will now build and public that commit

0 commit comments

Comments
 (0)