Skip to content

Commit 7f5fb32

Browse files
authored
Merge pull request #7 from gokhanamal/chore/repo-hygiene-ci
Repo hygiene: LICENSE, CI, contributing; align Swift tools
2 parents 2c2f065 + 1759dc9 commit 7f5fb32

File tree

4 files changed

+87
-1
lines changed

4 files changed

+87
-1
lines changed

.github/workflows/ci.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: [ main ]
7+
8+
jobs:
9+
build:
10+
runs-on: macos-latest
11+
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v4
15+
16+
- name: Select Xcode
17+
run: sudo xcode-select -s /Applications/Xcode.app
18+
19+
- name: Resolve
20+
run: swift package resolve
21+
22+
- name: Build (iOS)
23+
run: |
24+
xcodebuild -resolvePackageDependencies
25+
xcodebuild \
26+
-scheme IndieBuilderKit \
27+
-destination "generic/platform=iOS" \
28+
build

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to IndieBuilderKit
2+
3+
Thanks for your interest in contributing!
4+
5+
## Development setup
6+
7+
- Xcode 15+ recommended (Swift 5.9+)
8+
- iOS 17+ for the demo app
9+
10+
## Running the demo
11+
12+
Open:
13+
14+
- `Demo/IndieBuilderKitDemo.xcworkspace`
15+
16+
Build and run the `IndieBuilderKitDemo` target.
17+
18+
## Swift Package Manager
19+
20+
From the repo root:
21+
22+
```bash
23+
swift package resolve
24+
swift package build
25+
```
26+
27+
## Pull requests
28+
29+
- Keep PRs focused (small, reviewable changes)
30+
- Add/update documentation when changing public API
31+
- Add tests when you can (especially for services like NetworkService)
32+
33+
## Code style
34+
35+
- Prefer modern Swift Concurrency (async/await)
36+
- Keep public API surfaces documented
37+

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Gokhan Namal
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Package.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// swift-tools-version: 5.7
1+
// swift-tools-version: 5.9
22
// The swift-tools-version declares the minimum version of Swift required to build this package.
33

44
import PackageDescription

0 commit comments

Comments
 (0)